Class MonitorAttribute
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.monitors.MonitorAttribute
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class MonitorAttribute extends java.lang.Object implements java.io.Serializable
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.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description 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.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.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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Boolean
getBooleanValue()
Retrieves the value for this monitor attribute as aBoolean
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 aDate
object.java.util.List<java.util.Date>
getDateValues()
Retrieves the values for this monitor attribute as a list ofDate
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 aDouble
object.java.util.List<java.lang.Double>
getDoubleValues()
Retrieves the values for this monitor attribute as a list ofDouble
objects.java.lang.Integer
getIntegerValue()
Retrieves the value for this monitor attribute as anInteger
object.java.util.List<java.lang.Integer>
getIntegerValues()
Retrieves the values for this monitor attribute as a list ofInteger
objects.java.lang.Long
getLongValue()
Retrieves the value for this monitor attribute as aLong
object.java.util.List<java.lang.Long>
getLongValues()
Retrieves the values for this monitor attribute as a list ofLong
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 aString
object.java.util.List<java.lang.String>
getStringValues()
Retrieves the values for this monitor attribute as a list ofString
objects.java.lang.Object
getValue()
Retrieves the value for this monitor attribute as anObject
.java.util.List<java.lang.Object>
getValues()
Retrieves the set of values for this monitor attribute as a list ofObject
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.
-
-
-
Constructor Detail
-
MonitorAttribute
public 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. It will have a single Boolean value.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.value
- TheBoolean
value for this monitor attribute. It must not benull
.
-
MonitorAttribute
public 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. It will have a single Date value.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.value
- TheDate
value for this monitor attribute. It must not benull
.
-
MonitorAttribute
public 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. It will have one or more Date values.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.values
- The set ofDate
values for this monitor attribute. It must not benull
or empty.
-
MonitorAttribute
public 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. It will have a single Double value.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.value
- TheDouble
value for this monitor attribute. It must not benull
.
-
MonitorAttribute
public 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. It will have one or more Double values.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.values
- The set ofDouble
values for this monitor attribute. It must not benull
or empty.
-
MonitorAttribute
public 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. It will have a single Long value.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.value
- TheInteger
value for this monitor attribute. It must not benull
.
-
MonitorAttribute
public 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. It will have a single Long value.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.values
- The set ofInteger
values for this monitor attribute. It must not benull
or empty.
-
MonitorAttribute
public 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. It will have a single Long value.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.value
- TheLong
value for this monitor attribute. It must not benull
.
-
MonitorAttribute
public 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. It will have one or more Long values.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.values
- The set ofLong
values for this monitor attribute. It must not benull
or empty.
-
MonitorAttribute
public 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. It will have a single String value.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.value
- TheString
value for this monitor attribute. It must not benull
.
-
MonitorAttribute
public 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. It will have one or more String values.- Parameters:
name
- The name used to identify this monitor attribute. It must not benull
.displayName
- The human-readable display name for this monitor attribute. It must not benull
.description
- A human-readable description for this monitor attribute. It may benull
if no description is available.values
- The set ofString
values for this monitor attribute. It must not benull
or empty.
-
-
Method Detail
-
getName
public java.lang.String getName()
Retrieves the name used to identify this monitor attribute. It is not necessarily human-readable, but it should be used as the key for this monitor attribute in the map returned by theMonitorEntry.getMonitorAttributes
method.- Returns:
- The name used to identify this monitor attribute.
-
getDisplayName
public java.lang.String getDisplayName()
Retrieves the human-readable display name for this monitor attribute.- Returns:
- The human-readable display name for this monitor attribute.
-
getDescription
public java.lang.String getDescription()
Retrieves the human-readable description for this monitor attribute, if available.- Returns:
- The human-readable description for this monitor attribute, or
null
if none is available.
-
getDataType
public java.lang.Class<?> getDataType()
Retrieves the class representing the data type for this monitor attribute. It will be one of the following class types: Boolean, Date, Double, Long, or String.- Returns:
- The class representing the data type for this monitor attribute.
-
hasMultipleValues
public boolean hasMultipleValues()
Indicates whether this monitor attribute has multiple values.- Returns:
true
if this monitor attribute has more than one value, orfalse
if not.
-
getValue
public java.lang.Object getValue()
Retrieves the value for this monitor attribute as anObject
. If it has multiple values, then the first will be returned.- Returns:
- The value for this monitor attribute as an
Object
.
-
getValues
public java.util.List<java.lang.Object> getValues()
Retrieves the set of values for this monitor attribute as a list ofObject
s.- Returns:
- The set of values for this monitor attribute as a list of
Object
s.
-
getBooleanValue
public java.lang.Boolean getBooleanValue() throws java.lang.ClassCastException
Retrieves the value for this monitor attribute as aBoolean
object.- Returns:
- The value for this monitor attribute as a
Boolean
object. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notBoolean
.
-
getDateValue
public java.util.Date getDateValue() throws java.lang.ClassCastException
Retrieves the value for this monitor attribute as aDate
object.- Returns:
- The value for this monitor attribute as a
Date
object. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notDate
.
-
getDateValues
public java.util.List<java.util.Date> getDateValues() throws java.lang.ClassCastException
Retrieves the values for this monitor attribute as a list ofDate
objects.- Returns:
- The values for this monitor attribute as a list of
Date
objects. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notDate
.
-
getDoubleValue
public java.lang.Double getDoubleValue() throws java.lang.ClassCastException
Retrieves the value for this monitor attribute as aDouble
object.- Returns:
- The value for this monitor attribute as a
Double
object. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notDouble
.
-
getDoubleValues
public java.util.List<java.lang.Double> getDoubleValues() throws java.lang.ClassCastException
Retrieves the values for this monitor attribute as a list ofDouble
objects.- Returns:
- The values for this monitor attribute as a list of
Double
objects. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notDouble
.
-
getIntegerValue
public java.lang.Integer getIntegerValue() throws java.lang.ClassCastException
Retrieves the value for this monitor attribute as anInteger
object.- Returns:
- The value for this monitor attribute as an
Integer
object. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notInteger
.
-
getIntegerValues
public java.util.List<java.lang.Integer> getIntegerValues() throws java.lang.ClassCastException
Retrieves the values for this monitor attribute as a list ofInteger
objects.- Returns:
- The values for this monitor attribute as a list of
Integer
objects. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notInteger
.
-
getLongValue
public java.lang.Long getLongValue() throws java.lang.ClassCastException
Retrieves the value for this monitor attribute as aLong
object.- Returns:
- The value for this monitor attribute as a
Long
object. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notLong
.
-
getLongValues
public java.util.List<java.lang.Long> getLongValues() throws java.lang.ClassCastException
Retrieves the values for this monitor attribute as a list ofLong
objects.- Returns:
- The values for this monitor attribute as a list of
Long
objects. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notLong
.
-
getStringValue
public java.lang.String getStringValue() throws java.lang.ClassCastException
Retrieves the value for this monitor attribute as aString
object.- Returns:
- The value for this monitor attribute as a
String
object. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notString
.
-
getStringValues
public java.util.List<java.lang.String> getStringValues() throws java.lang.ClassCastException
Retrieves the values for this monitor attribute as a list ofString
objects.- Returns:
- The values for this monitor attribute as a list of
String
objects. - Throws:
java.lang.ClassCastException
- If the data type for this monitor attribute is notString
.
-
toString
public java.lang.String toString()
Retrieves a string representation of this monitor attribute.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this monitor attribute.
-
toString
public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this monitor attribute to the provided buffer.- Parameters:
buffer
- The buffer to which the string representation should be appended.
-
-