com.cisco.provisioning.cpe.api
Enum KeyType

java.lang.Object
  extended by java.lang.Enum<KeyType>
      extended by com.cisco.provisioning.cpe.api.KeyType
All Implemented Interfaces:
Serializable, Comparable<KeyType>

public enum KeyType
extends Enum<KeyType>

An enumeration of the KeyType to indicate the type of the object returned from the search query


Enum Constant Summary
DUID
          The returned Key object from search results is DUID
FILE_NAME
          The returned Key object from search results is FileName
FQDN
          The returned Key object from search results is FQDN
MAC_ADDRESS
          The returned Key object from search results is MACAddress
NODE_NAME
          The returned Key object from search resutls is NodeName
OID
          The returned Key object from search results is DeviceOid
 
Method Summary
static KeyType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static KeyType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

DUID

public static final KeyType DUID
The returned Key object from search results is DUID


FQDN

public static final KeyType FQDN
The returned Key object from search results is FQDN


MAC_ADDRESS

public static final KeyType MAC_ADDRESS
The returned Key object from search results is MACAddress


NODE_NAME

public static final KeyType NODE_NAME
The returned Key object from search resutls is NodeName


OID

public static final KeyType OID
The returned Key object from search results is DeviceOid


FILE_NAME

public static final KeyType FILE_NAME
The returned Key object from search results is FileName

Method Detail

values

public static KeyType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (KeyType c : KeyType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeyType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null