001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.scxml2;
018
019import java.io.Serializable;
020
021/**
022 * Implementation of the SCXML specification required In() builtin predicate.
023 */
024public class Builtin implements Serializable {
025
026    /**
027     * Serial version UID.
028     */
029    private static final long serialVersionUID = 1L;
030
031    /**
032     * Implements the In() predicate for SCXML documents. The method
033     * name chosen is different since "in" is a reserved token
034     * in some expression languages.
035     *
036     * Simple ID based comparator, assumes IDs are unique.
037     *
038     * @param ctx variable context
039     * @param state The State ID to compare with
040     * @return Whether this State is current active
041     */
042    @SuppressWarnings("unchecked")
043    public static boolean isMember(final Context ctx, final String state) {
044        return ((Status)ctx.getSystemContext().getPlatformVariables().get(SCXMLSystemContext.STATUS_KEY)).isInState(state);
045    }
046}
047