KeyTool (g9 Common 2.8.1 API)

java.lang.Object
- no.g9.os.KeyTool

```
public class KeyTool
extends Object
```
The KeyTool class is a utility class, helping with various aspects of keys. The class contains an UNDEFINED_VALUE value for all primitive java types (e.g UNDEFINED_VALUE_BYTE, and methods to test if an attribute is indeed defined.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`UNDEFINED_VALUE_BOOLEAN` The default UNDEFINED value for a boolean primitive (which is false).
`static byte`	`UNDEFINED_VALUE_BYTE` The default UNDEFINED value for a byte primitive (which is 0).
`static char`	`UNDEFINED_VALUE_CHAR` The default UNDEFINED value for a char primitive (which is 0).
`static double`	`UNDEFINED_VALUE_DOUBLE` The default UNDEFINED value for a double primitive (which is 0.0).
`static float`	`UNDEFINED_VALUE_FLOAT` The default UNDEFINED value for a float primitive (which is 0.0).
`static int`	`UNDEFINED_VALUE_INT` The default UNDEFINED value for an integer primitive (which is 0).
`static long`	`UNDEFINED_VALUE_LONG` The default UNDEFINED value for a long primitive (which is 0).
`static String`	`UNDEFINED_VALUE_STRING` The default UNDEFINED value for a String (which is an empty String).

Constructor Summary

Constructors
Constructor and Description

KeyTool()

Constructors
Constructor and Description
`KeyTool()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`attributesDefined(Object instance, OSRole<?> role, AttributeConstant[] attributes)` Check if the specified instance contains defined values for all the attributes specified attribute array (see various `isDefined` methods).
`static Key`	`getCompleteUniqueKey(Object instance, OSRole<?> role)` Searches the specified instance for a defined key (a key where all attributes are defined), and returns the name of the first completely defined key.
`static boolean`	`isDefined(boolean primitive)` Check if the specified primitive is defined.
`static boolean`	`isDefined(Boolean b)` Check if the specified primitive wrapper is defined.
`static boolean`	`isDefined(byte primitive)` Check if the specified primitive is defined.
`static boolean`	`isDefined(Byte b)` Check if the specified primitive wrapper is defined.
`static boolean`	`isDefined(char primitive)` Check if the specified primitive is defined.
`static boolean`	`isDefined(Character c)` Check if the specified primitive wrapper is defined.
`static boolean`	`isDefined(double primitive)` Check if the specified primitive is defined.
`static boolean`	`isDefined(Double d)` Check if the specified primitive wrapper is defined.
`static boolean`	`isDefined(float primitive)` Check if the specified primitive is defined.
`static boolean`	`isDefined(Float f)` Check if the specified primitive wrapper is defined.
`static boolean`	`isDefined(int primitive)` Check if the specified primitive is defined.
`static boolean`	`isDefined(Integer i)` Check if the specified primitive wrapper is defined.
`static boolean`	`isDefined(long primitive)` Check if the specified primitive is defined.
`static boolean`	`isDefined(Long l)` Check if the specified primitive wrapper is defined.
`static boolean`	`isDefined(Object o)` Check if the specified object is defined.
`static boolean`	`isDefined(String s)` Check if the specified String is defined.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNDEFINED_VALUE_BYTE
```
public static final byte UNDEFINED_VALUE_BYTE
```
    The default UNDEFINED value for a byte primitive (which is 0).
    
    See Also:
    
    Constant Field Values
  - UNDEFINED_VALUE_CHAR
```
public static final char UNDEFINED_VALUE_CHAR
```
    The default UNDEFINED value for a char primitive (which is 0).
    
    See Also:
    
    Constant Field Values
  - UNDEFINED_VALUE_INT
```
public static final int UNDEFINED_VALUE_INT
```
    The default UNDEFINED value for an integer primitive (which is 0).
    
    See Also:
    
    Constant Field Values
  - UNDEFINED_VALUE_LONG
```
public static final long UNDEFINED_VALUE_LONG
```
    The default UNDEFINED value for a long primitive (which is 0).
    
    See Also:
    
    Constant Field Values
  - UNDEFINED_VALUE_FLOAT
```
public static final float UNDEFINED_VALUE_FLOAT
```
    The default UNDEFINED value for a float primitive (which is 0.0).
    
    See Also:
    
    Constant Field Values
  - UNDEFINED_VALUE_DOUBLE
```
public static final double UNDEFINED_VALUE_DOUBLE
```
    The default UNDEFINED value for a double primitive (which is 0.0).
    
    See Also:
    
    Constant Field Values
  - UNDEFINED_VALUE_BOOLEAN
```
public static final boolean UNDEFINED_VALUE_BOOLEAN
```
    The default UNDEFINED value for a boolean primitive (which is false).
    
    See Also:
    
    Constant Field Values
  - UNDEFINED_VALUE_STRING
```
public static final String UNDEFINED_VALUE_STRING
```
    The default UNDEFINED value for a String (which is an empty String).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KeyTool
```
public KeyTool()
```
- Method Detail
  - getCompleteUniqueKey
```
public static Key getCompleteUniqueKey(Object instance,
                                       OSRole<?> role)
```
    Searches the specified instance for a defined key (a key where all attributes are defined), and returns the name of the first completely defined key.
    
    Parameters:
    
    instance - the instance.
    
    role - the instance role.
    
    Returns:
    
    the complete unique key.
  - attributesDefined
```
public static boolean attributesDefined(Object instance,
                                        OSRole<?> role,
                                        AttributeConstant[] attributes)
```
    Check if the specified instance contains defined values for all the attributes specified attribute array (see various isDefined methods).
    
    Parameters:
    
    instance - the instance to check attributes in.
    
    role - the object selection role of the instance.
    
    attributes - an array containing the attribute names.
    
    Returns:
    
    true if all values defined by the attribute array are defined.
  - isDefined
```
public static boolean isDefined(byte primitive)
```
    Check if the specified primitive is defined. A primitive value is defined if it's value is different from the primitives declared UNDEFINED value.
    
    Parameters:
    
    primitive - the value to verify
    
    Returns:
    
    false if the specified value equals the primitive's UNDEFINED value, otherwise true
    
    See Also:
    
    UNDEFINED_VALUE_BYTE
  - isDefined
```
public static boolean isDefined(Byte b)
```
    Check if the specified primitive wrapper is defined. A primitive wrapper is defined if it is not null and the wrapped primitive value is defined.
    
    Parameters:
    
    b - the wrapper to verify.
    
    Returns:
    
    false if the wrapper is either null or wrapped primitive equals the primitive's UNDEFINED value.
  - isDefined
```
public static boolean isDefined(char primitive)
```
    Check if the specified primitive is defined. A primitive value is defined if it's value is different from the primitives declared UNDEFINED value.
    
    Parameters:
    
    primitive - the value to verify
    
    Returns:
    
    false if the specified value equals the primitive's UNDEFINED value, otherwise true.
    
    See Also:
    
    UNDEFINED_VALUE_CHAR
  - isDefined
```
public static boolean isDefined(Character c)
```
    Check if the specified primitive wrapper is defined. A primitive wrapper is defined if it is not null and the wrapped primitive value is defined.
    
    Parameters:
    
    c - the wrapper to verify.
    
    Returns:
    
    false if the wrapper is either null or wrapped primitive equals the primitive's UNDEFINED value.
    
    See Also:
    
    isDefined(char)
  - isDefined
```
public static boolean isDefined(int primitive)
```
    Check if the specified primitive is defined. A primitive value is defined if it's value is different from the primitives declared UNDEFINED value.
    
    Parameters:
    
    primitive - the value to verify
    
    Returns:
    
    false if the specified value equals the primitive's UNDEFINED value, otherwise true.
    
    See Also:
    
    UNDEFINED_VALUE_INT
  - isDefined
```
public static boolean isDefined(Integer i)
```
    Check if the specified primitive wrapper is defined. A primitive wrapper is defined if it is not null and the wrapped primitive value is defined.
    
    Parameters:
    
    i - the wrapper to verify.
    
    Returns:
    
    false if the wrapper is either null or wrapped primitive equals the primitive's UNDEFINED value.
    
    See Also:
    
    isDefined(int)
  - isDefined
```
public static boolean isDefined(long primitive)
```
    Check if the specified primitive is defined. A primitive value is defined if it's value is different from the primitives declared UNDEFINED value.
    
    Parameters:
    
    primitive - the value to verify
    
    Returns:
    
    false if the specified value equals the primitive's UNDEFINED value, otherwise true.
    
    See Also:
    
    UNDEFINED_VALUE_LONG
  - isDefined
```
public static boolean isDefined(Long l)
```
    Check if the specified primitive wrapper is defined. A primitive wrapper is defined if it is not null and the wrapped primitive value is defined.
    
    Parameters:
    
    l - the wrapper to verify.
    
    Returns:
    
    false if the wrapper is either null or wrapped primitive equals the primitive's UNDEFINED value.
    
    See Also:
    
    isDefined(long)
  - isDefined
```
public static boolean isDefined(float primitive)
```
    Check if the specified primitive is defined. A primitive value is defined if it's value is different from the primitives declared UNDEFINED value.
    
    Parameters:
    
    primitive - the value to verify
    
    Returns:
    
    false if the specified value equals the primitive's UNDEFINED value, otherwise true.
    
    See Also:
    
    UNDEFINED_VALUE_FLOAT
  - isDefined
```
public static boolean isDefined(Float f)
```
    Check if the specified primitive wrapper is defined. A primitive wrapper is defined if it is not null and the wrapped primitive value is defined.
    
    Parameters:
    
    f - the wrapper to verify.
    
    Returns:
    
    false if the wrapper is either null or wrapped primitive equals the primitive's UNDEFINED value.
    
    See Also:
    
    isDefined(float)
  - isDefined
```
public static boolean isDefined(double primitive)
```
    Check if the specified primitive is defined. A primitive value is defined if it's value is different from the primitives declared UNDEFINED value.
    
    Parameters:
    
    primitive - the value to verify
    
    Returns:
    
    false if the specified value equals the primitive's UNDEFINED value, otherwise true.
    
    See Also:
    
    UNDEFINED_VALUE_DOUBLE
  - isDefined
```
public static boolean isDefined(Double d)
```
    Check if the specified primitive wrapper is defined. A primitive wrapper is defined if it is not null and the wrapped primitive value is defined.
    
    Parameters:
    
    d - the wrapper to verify.
    
    Returns:
    
    false if the wrapper is either null or wrapped primitive equals the primitive's UNDEFINED value.
    
    See Also:
    
    isDefined(double)
  - isDefined
```
public static boolean isDefined(boolean primitive)
```
    Check if the specified primitive is defined. A primitive value is defined if it's value is different from the primitives declared UNDEFINED value.
    
    Parameters:
    
    primitive - the value to verify
    
    Returns:
    
    false if the specified value equals the primitive's UNDEFINED value, otherwise true.
    
    See Also:
    
    UNDEFINED_VALUE_BOOLEAN
  - isDefined
```
public static boolean isDefined(Boolean b)
```
    Check if the specified primitive wrapper is defined. A primitive wrapper is defined if it is not null and the wrapped primitive value is defined.
    
    Parameters:
    
    b - the wrapper to verify.
    
    Returns:
    
    false if the wrapper is either null or wrapped primitive equals the primitive's UNDEFINED value.
  - isDefined
```
public static boolean isDefined(String s)
```
    Check if the specified String is defined. A String is defined if it contains any characters (including whitespace).
    
    Parameters:
    
    s - the String to verify
    
    Returns:
    
    false if the specified String is null or of zero length.
    
    See Also:
    
    UNDEFINED_VALUE_STRING
  - isDefined
```
public static boolean isDefined(Object o)
```
    Check if the specified object is defined. An object is defined if it's not a null reference.
    If the object is a primitive wrapper (Byte, Character, Integer, Long, Float or Double), or a String, the reference is narrowed and the corresponding isDefined method is invoked (e.g. if this method is invoked with an Integer reference, the object is casted to an Integer, and the isDefined(Integer) method is invoked).
    
    Parameters:
    
    o - the value to verify
    
    Returns:
    
    false if the specified value is undefined, otherwise true.

Class KeyTool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNDEFINED_VALUE_BYTE

UNDEFINED_VALUE_CHAR

UNDEFINED_VALUE_INT

UNDEFINED_VALUE_LONG

UNDEFINED_VALUE_FLOAT

UNDEFINED_VALUE_DOUBLE

UNDEFINED_VALUE_BOOLEAN

UNDEFINED_VALUE_STRING

Constructor Detail

KeyTool

Method Detail

getCompleteUniqueKey

attributesDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined

isDefined