org.jscsi.target.settings

Class KeySet

java.lang.Object

org.jscsi.target.settings.KeySet

public final class KeySet
extends Object

KeySet objects are used by Entry instances for storing all keys that might be used to negotiate the parameter managed by the Entry. Individual keys are represented as String objects.

Although most parameters are associated with just one key, there are some exceptions, hence justifying the added complexity of using a dedicated class for managing keys in favor of simply using multiple String objects.

Author:

Andreas Ergenzinger

Constructor Summary

Constructors

Constructor and Description
KeySet(String value) Constructor for creating KeySet instances with just one key.
KeySet(String firstValue, String... additionalValues) Constructor for creating KeySet instances with multiple keys.

Method Summary

Methods

Modifier and Type	Method and Description
String	getValue() Returns the primary key, stored at the first position in values.
String	getValue(int index) Returns the key stored at the specified position in values.
boolean	matchKey(String key) Returns true if one of the keys in the set equals the parameter.
int	size() Returns the number of keys in this set.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

KeySet

public KeySet(String value)

Constructor for creating KeySet instances with just one key.

Parameters:

value - the key

KeySet

public KeySet(String firstValue,
      String... additionalValues)

Constructor for creating KeySet instances with multiple keys.

Parameters:

firstValue - the first key

additionalValues - additional keys

Method Detail

matchKey

public boolean matchKey(String key)

Returns true if one of the keys in the set equals the parameter.

Parameters:

key - the key to compare to the set's keys

Returns:

true if there is a match, false if there is not

getValue

public String getValue()

Returns the primary key, stored at the first position in values.

Returns:

the primary key

getValue

public String getValue(int index)

Returns the key stored at the specified position in values.

Parameters:

index - the position of the requested key in values

Returns:

the key stored at the specified position in values

size

public int size()

Returns the number of keys in this set.

Returns:

the number of keys in this set

toString

public String toString()

Overrides:

toString in class Object