desmoj.extensions.experimentation.util

Class AccessUtil

java.lang.Object

desmoj.extensions.experimentation.util.AccessUtil

public class AccessUtil
extends java.lang.Object

Utility class for working with access points.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Author:

Nicolas Knaak

Constructor Summary

Constructors

Constructor and Description
AccessUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	contains(java.lang.String name, java.util.Map accessPoints) tests if this map contains an access point with the given name.
static java.lang.String[]	getAccessPointNames(java.util.Map accessPoints)
static AccessPoint[]	getAccessPoints(java.util.Map accessPoints)
static java.lang.Object[]	getAccessPointValues(java.util.Map accessPoints)
static boolean	getBooleanValue(java.lang.String name, java.util.Map accessPoints) Convenience method to retrieve the boolean value of an access point with a given name from the map.
static double	getDoubleValue(java.lang.String name, java.util.Map accessPoints) Convenience method to retrieve the double value of an access point with a given name from the map.
static int	getIndexof(java.lang.String searchedName, java.util.Map accessPoints)
static int	getIntValue(java.lang.String name, java.util.Map accessPoints) Convenience method to retrieve the int value of an access point with a given name from the map.
static java.lang.String	getStringValue(java.lang.String name, java.util.Map accessPoints) Convenience method to retrieve the String value of an access point with a given name from the map.
static java.util.concurrent.TimeUnit	getTimeUnitValue(java.lang.String name, java.util.Map accessPoints) Convenience method to retrieve the TimeUnit value of an access point with a given name from the map.
static java.lang.Object	getValue(java.lang.String name, java.util.Map accessPoints) Retrieves the value of an access point with a given name from the map.
static void	init(java.util.Map accessPoints, java.util.Map m) Inits the values of all access points in the given map from a map of values.
static boolean	isMutable(java.lang.String name, java.util.Map accessPoints) tests if the access point with the given name is mutable.
static void	put(java.util.Map accessPoints, AccessPoint apt) Put an access point into the given map.
static boolean	setValue(java.util.Map accessPoints, java.lang.String accName, java.lang.Object value) sets the specified access point to the given value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccessUtil

public AccessUtil()

Method Detail

put

public static void put(java.util.Map accessPoints,
                       AccessPoint apt)

Put an access point into the given map. The access point will be the value and the access point's name will be the key.

Parameters:

accessPoints - a map containing pairs.

apt - an access point to be added to the map.

getValue

public static java.lang.Object getValue(java.lang.String name,
                                        java.util.Map accessPoints)

Retrieves the value of an access point with a given name from the map.

Parameters:

name - name of an access point

accessPoints - map containing pairs.

Returns:

current value of the access point

getStringValue

public static java.lang.String getStringValue(java.lang.String name,
                                              java.util.Map accessPoints)

Convenience method to retrieve the String value of an access point with a given name from the map.

Parameters:

name - name of an access point

accessPoints - map containing pairs.

Returns:

current string value of the access point

getTimeUnitValue

public static java.util.concurrent.TimeUnit getTimeUnitValue(java.lang.String name,
                                                             java.util.Map accessPoints)

Convenience method to retrieve the TimeUnit value of an access point with a given name from the map.

Parameters:

name - name of an access point

accessPoints - map containing pairs.

Returns:

current string value of the access point

getBooleanValue

public static boolean getBooleanValue(java.lang.String name,
                                      java.util.Map accessPoints)

Convenience method to retrieve the boolean value of an access point with a given name from the map.

Parameters:

name - name of an access point

accessPoints - map containing pairs.

Returns:

current boolean value of the access point

getIntValue

public static int getIntValue(java.lang.String name,
                              java.util.Map accessPoints)

Convenience method to retrieve the int value of an access point with a given name from the map.

Parameters:

name - name of an access point

accessPoints - map containing pairs.

Returns:

current int value of the access point

getDoubleValue

public static double getDoubleValue(java.lang.String name,
                                    java.util.Map accessPoints)

Convenience method to retrieve the double value of an access point with a given name from the map.

Parameters:

name - name of an access point

accessPoints - map containing pairs.

Returns:

current double value of the access point

getAccessPointNames

public static java.lang.String[] getAccessPointNames(java.util.Map accessPoints)

Returns:

an array of all contained access point's names.

getIndexof

public static int getIndexof(java.lang.String searchedName,
                             java.util.Map accessPoints)

Parameters:

searchedName - an access point name.

Returns:

the internal index of a given access point name. If the access point does not exist -1 is returned

getAccessPointValues

public static java.lang.Object[] getAccessPointValues(java.util.Map accessPoints)

Returns:

an object array of all access points' current values.

getAccessPoints

public static AccessPoint[] getAccessPoints(java.util.Map accessPoints)

Returns:

the access points as an array.

contains

public static boolean contains(java.lang.String name,
                               java.util.Map accessPoints)

tests if this map contains an access point with the given name.

Parameters:

name - an access point's name

map - a map containing access points

Returns:

true iff the map contains an access point with the given name

isMutable

public static boolean isMutable(java.lang.String name,
                                java.util.Map accessPoints)

tests if the access point with the given name is mutable.

Parameters:

name - an access point's name

accessPoints - a map containing access points

Returns:

true iff the access point with the given name is a MutableAccessPoint

setValue

public static boolean setValue(java.util.Map accessPoints,
                               java.lang.String accName,
                               java.lang.Object value)

sets the specified access point to the given value. Returns true if this was successful (i.e. if the access point is mutable) or false otherwise.

Parameters:

accName - the name of the access point to change

value - the value to set the accessed attribute to.

accessPoints - a map containing access points

Returns:

status of "set" operation

init

public static void init(java.util.Map accessPoints,
                        java.util.Map m)

Inits the values of all access points in the given map from a map of values. This map must contain key/value pairs where the key is a string corresponding to an access point's name and the value is an object fitting the accessed attributes type.

Parameters:

accessPoints - a map containing access points

m - a java.util.Map to initialize the given map of access points from.