com.ibm.datapower.wamt
Class DeviceType

java.lang.Object
  extended by com.ibm.datapower.wamt.DeviceType

public class DeviceType
extends java.lang.Object

This class provides a set of enumerated values for the device type, as opposed to using String values. You should use the public fields and the methods included here.

The device type describes generally the capabilities of the appliance based on the software. In general, the XS40 is a superset of the XS35, and the XI50 is a superset of the XS40. Also be aware that there may be more DeviceTypes than the enums listed here, as this class supports creation of DeviceTypes not known apriori. The enums are here only as a convenience. Be sure to use the #equals(DeviceType) method and not the == operator when comparing for equality.

The descriptions in this class were NOT NLS enabled, because they are unlikely to ever be internationalized. The descriptions are copied directly from the device metadata, see Commands.getDeviceMetaInfo(com.ibm.datapower.wamt.amp.DeviceContext).

See Also:
DeviceTypeIncompatibilityException

Field Summary
static java.lang.String COPYRIGHT_2009_2013
           
static DeviceType XA35
          A device that is an XA35.
static DeviceType XB50
          A device that is an XB50.
static DeviceType XB52
          A device that is an XB52
static DeviceType XC10
          A device that is an XG45
static DeviceType XE82
          A device that is an XE82
static DeviceType XG45
          A device that is an XG45
static DeviceType XI50
          A device that is an XI50.
static DeviceType XI52
          A device that is an XI52
static DeviceType XM70
          A device that is an XM70.
static DeviceType XS40
          A device that is an XS40.
 
Constructor Summary
DeviceType(java.lang.String description)
          Create a new DeviceType object.
 
Method Summary
 boolean equals(java.lang.Object that)
          Compare two DeviceType objects to see if they are equivalent.
static DeviceType fromString(java.lang.String dirtyString)
          Get a DeviceType instance based on the human-readable String representation of the instance.
 java.lang.String getDisplayName()
          Get a String description of this object that is suitable for display to an end user.
 int hashCode()
           
 boolean isCompatibleWith(DeviceType that)
          Check if two DeviceType objects are compatible with each other.
 java.lang.String toString()
          Get a human-readable String representation of this object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT_2009_2013

public static final java.lang.String COPYRIGHT_2009_2013
See Also:
Constant Field Values

XA35

public static final DeviceType XA35
A device that is an XA35.


XM70

public static final DeviceType XM70
A device that is an XM70.


XS40

public static final DeviceType XS40
A device that is an XS40.


XI50

public static final DeviceType XI50
A device that is an XI50.


XI52

public static final DeviceType XI52
A device that is an XI52


XB50

public static final DeviceType XB50
A device that is an XB50.


XB52

public static final DeviceType XB52
A device that is an XB52


XE82

public static final DeviceType XE82
A device that is an XE82


XG45

public static final DeviceType XG45
A device that is an XG45


XC10

public static final DeviceType XC10
A device that is an XG45

Constructor Detail

DeviceType

public DeviceType(java.lang.String description)
Create a new DeviceType object. The use of fromString(String) is preferred, because it will attempt to reuse objects for known Strings.

Parameters:
description - the text identifier of the device type, such as "XS40".
Method Detail

equals

public boolean equals(java.lang.Object that)
Compare two DeviceType objects to see if they are equivalent.

Overrides:
equals in class java.lang.Object
Parameters:
that - the other DeviceType object to compare to "this".
Returns:
true if the objects are equivalent, false otherwise
See Also:
isCompatibleWith(DeviceType)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

isCompatibleWith

public boolean isCompatibleWith(DeviceType that)
Check if two DeviceType objects are compatible with each other. This is used to determine if a firmware can be deployed to this Device.

Parameters:
that - the other DeviceType to compare to "this"
Returns:
true if the objects are compatible with each other, false otherwise
See Also:
#equals(DeviceType)

toString

public java.lang.String toString()
Get a human-readable String representation of this object. This is more for debugging than for end-user consumption.

Overrides:
toString in class java.lang.Object
Returns:
a human-readable String representation of this object
See Also:
getDisplayName()

getDisplayName

public java.lang.String getDisplayName()
Get a String description of this object that is suitable for display to an end user. This was NOT NLS enabled because the DeviceTypes descriptions are constants

Returns:
a String description of this object that is suitable for display to an end user.
See Also:
toString()

fromString

public static final DeviceType fromString(java.lang.String dirtyString)
Get a DeviceType instance based on the human-readable String representation of the instance.

Parameters:
dirtyString - A String previously returned by DeviceType.toString()
Returns:
An instance of DeviceType that would return the value deviceTypeString if toString was called on it. The benefit of using this method over DeviceType(String) is that this method will attempt to reuse instances if they are available. If the String does not exist in a known enum, then it will instantiate a new object.


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.