|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.monitors.MonitorAttribute
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class MonitorAttribute
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides a data structure for providing information about the data presented in an attribute in a Directory Server monitor entry. It includes a human-readable display name, a human-readable description, a class that represents the data type for the values, and the set of values.
Constructor Summary | |
---|---|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.lang.Boolean value)
Creates a new monitor attribute with the provided information. |
|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.util.Date value)
Creates a new monitor attribute with the provided information. |
|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.util.Date[] values)
Creates a new monitor attribute with the provided information. |
|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.lang.Double value)
Creates a new monitor attribute with the provided information. |
|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.lang.Double[] values)
Creates a new monitor attribute with the provided information. |
|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.lang.Integer value)
Creates a new monitor attribute with the provided information. |
|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.lang.Integer[] values)
Creates a new monitor attribute with the provided information. |
|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.lang.Long value)
Creates a new monitor attribute with the provided information. |
|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.lang.Long[] values)
Creates a new monitor attribute with the provided information. |
|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.lang.String value)
Creates a new monitor attribute with the provided information. |
|
MonitorAttribute(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
java.lang.String[] values)
Creates a new monitor attribute with the provided information. |
Method Summary | |
---|---|
java.lang.Boolean |
getBooleanValue()
Retrieves the value for this monitor attribute as a Boolean object. |
java.lang.Class<?> |
getDataType()
Retrieves the class representing the data type for this monitor attribute. |
java.util.Date |
getDateValue()
Retrieves the value for this monitor attribute as a Date object. |
java.util.List<java.util.Date> |
getDateValues()
Retrieves the values for this monitor attribute as a list of Date
objects. |
java.lang.String |
getDescription()
Retrieves the human-readable description for this monitor attribute, if available. |
java.lang.String |
getDisplayName()
Retrieves the human-readable display name for this monitor attribute. |
java.lang.Double |
getDoubleValue()
Retrieves the value for this monitor attribute as a Double object. |
java.util.List<java.lang.Double> |
getDoubleValues()
Retrieves the values for this monitor attribute as a list of Double
objects. |
java.lang.Integer |
getIntegerValue()
Retrieves the value for this monitor attribute as an Integer
object. |
java.util.List<java.lang.Integer> |
getIntegerValues()
Retrieves the values for this monitor attribute as a list of Integer objects. |
java.lang.Long |
getLongValue()
Retrieves the value for this monitor attribute as a Long object. |
java.util.List<java.lang.Long> |
getLongValues()
Retrieves the values for this monitor attribute as a list of Long
objects. |
java.lang.String |
getName()
Retrieves the name used to identify this monitor attribute. |
java.lang.String |
getStringValue()
Retrieves the value for this monitor attribute as a String object. |
java.util.List<java.lang.String> |
getStringValues()
Retrieves the values for this monitor attribute as a list of String
objects. |
java.lang.Object |
getValue()
Retrieves the value for this monitor attribute as an Object . |
java.util.List<java.lang.Object> |
getValues()
Retrieves the set of values for this monitor attribute as a list of Object s. |
boolean |
hasMultipleValues()
Indicates whether this monitor attribute has multiple values. |
java.lang.String |
toString()
Retrieves a string representation of this monitor attribute. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this monitor attribute to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Boolean value)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.value
- The Boolean
value for this monitor attribute.
It must not be null
.public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.util.Date value)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.value
- The Date
value for this monitor attribute. It
must not be null
.public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.util.Date[] values)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.values
- The set of Date
values for this monitor
attribute. It must not be null
or empty.public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Double value)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.value
- The Double
value for this monitor attribute.
It must not be null
.public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Double[] values)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.values
- The set of Double
values for this monitor
attribute. It must not be null
or empty.public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Integer value)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.value
- The Integer
value for this monitor attribute.
It must not be null
.public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Integer[] values)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.values
- The set of Integer
values for this monitor
attribute. It must not be null
or empty.public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Long value)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.value
- The Long
value for this monitor attribute. It
must not be null
.public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Long[] values)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.values
- The set of Long
values for this monitor
attribute. It must not be null
or empty.public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String value)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.value
- The String
value for this monitor attribute.
It must not be null
.public MonitorAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String[] values)
name
- The name used to identify this monitor attribute. It
must not be null
.displayName
- The human-readable display name for this monitor
attribute. It must not be null
.description
- A human-readable description for this monitor
attribute. It may be null
if no description
is available.values
- The set of String
values for this monitor
attribute. It must not be null
or empty.Method Detail |
---|
public java.lang.String getName()
MonitorEntry.getMonitorAttributes
method.
public java.lang.String getDisplayName()
public java.lang.String getDescription()
null
if none is available.public java.lang.Class<?> getDataType()
public boolean hasMultipleValues()
true
if this monitor attribute has more than one value, or
false
if not.public java.lang.Object getValue()
Object
. If it
has multiple values, then the first will be returned.
Object
.public java.util.List<java.lang.Object> getValues()
Object
s.
Object
s.public java.lang.Boolean getBooleanValue() throws java.lang.ClassCastException
Boolean
object.
Boolean
object.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not Boolean
.public java.util.Date getDateValue() throws java.lang.ClassCastException
Date
object.
Date
object.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not Date
.public java.util.List<java.util.Date> getDateValues() throws java.lang.ClassCastException
Date
objects.
Date
objects.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not Date
.public java.lang.Double getDoubleValue() throws java.lang.ClassCastException
Double
object.
Double
object.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not Double
.public java.util.List<java.lang.Double> getDoubleValues() throws java.lang.ClassCastException
Double
objects.
Double
objects.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not Double
.public java.lang.Integer getIntegerValue() throws java.lang.ClassCastException
Integer
object.
Integer
object.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not Integer
.public java.util.List<java.lang.Integer> getIntegerValues() throws java.lang.ClassCastException
Integer
objects.
Integer
objects.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not Integer
.public java.lang.Long getLongValue() throws java.lang.ClassCastException
Long
object.
Long
object.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not Long
.public java.util.List<java.lang.Long> getLongValues() throws java.lang.ClassCastException
Long
objects.
Long
objects.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not Long
.public java.lang.String getStringValue() throws java.lang.ClassCastException
String
object.
String
object.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not String
.public java.util.List<java.lang.String> getStringValues() throws java.lang.ClassCastException
String
objects.
String
objects.
java.lang.ClassCastException
- If the data type for this monitor attribute is
not String
.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the string representation should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |