Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2008-2017 UnboundID Corp.
* All Rights Reserved.
*/
/*
* Copyright (C) 2015-2017 UnboundID Corp.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.monitors;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.List;
import com.unboundid.util.NotMutable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.util.Validator.*;
/**
* 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 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.
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class MonitorAttribute
implements Serializable
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 7931725606171964572L;
// The data type for the values of this monitor attribute.
private final Class dataType;
// The set of values for this monitor attribute.
private final Object[] values;
// The description for this monitor attribute.
private final String description;
// The display name for this monitor attribute.
private final String displayName;
// The name used to identify this monitor attribute.
private final String name;
/**
* Creates a new monitor attribute with the provided information. It will
* have a single Boolean value.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param value The {@code Boolean} value for this monitor attribute.
* It must not be {@code null}.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final Boolean value)
{
this(name, displayName, description, Boolean.class, new Object[] { value });
ensureNotNull(value);
}
/**
* Creates a new monitor attribute with the provided information. It will
* have a single Date value.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param value The {@code Date} value for this monitor attribute. It
* must not be {@code null}.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final Date value)
{
this(name, displayName, description, Date.class, new Object[] { value });
ensureNotNull(value);
}
/**
* Creates a new monitor attribute with the provided information. It will
* have one or more Date values.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param values The set of {@code Date} values for this monitor
* attribute. It must not be {@code null} or empty.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final Date[] values)
{
this(name, displayName, description, Date.class, values);
}
/**
* Creates a new monitor attribute with the provided information. It will
* have a single Double value.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param value The {@code Double} value for this monitor attribute.
* It must not be {@code null}.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final Double value)
{
this(name, displayName, description, Double.class, new Object[] { value });
ensureNotNull(value);
}
/**
* Creates a new monitor attribute with the provided information. It will
* have one or more Double values.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param values The set of {@code Double} values for this monitor
* attribute. It must not be {@code null} or empty.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final Double[] values)
{
this(name, displayName, description, Double.class, values);
}
/**
* Creates a new monitor attribute with the provided information. It will
* have a single Long value.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param value The {@code Integer} value for this monitor attribute.
* It must not be {@code null}.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final Integer value)
{
this(name, displayName, description, Integer.class, new Object[] { value });
ensureNotNull(value);
}
/**
* Creates a new monitor attribute with the provided information. It will
* have a single Long value.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param values The set of {@code Integer} values for this monitor
* attribute. It must not be {@code null} or empty.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final Integer[] values)
{
this(name, displayName, description, Integer.class, values);
}
/**
* Creates a new monitor attribute with the provided information. It will
* have a single Long value.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param value The {@code Long} value for this monitor attribute. It
* must not be {@code null}.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final Long value)
{
this(name, displayName, description, Long.class, new Object[] { value });
ensureNotNull(value);
}
/**
* Creates a new monitor attribute with the provided information. It will
* have one or more Long values.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param values The set of {@code Long} values for this monitor
* attribute. It must not be {@code null} or empty.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final Long[] values)
{
this(name, displayName, description, Long.class, values);
}
/**
* Creates a new monitor attribute with the provided information. It will
* have a single String value.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param value The {@code String} value for this monitor attribute.
* It must not be {@code null}.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final String value)
{
this(name, displayName, description, String.class, new Object[] { value });
ensureNotNull(value);
}
/**
* Creates a new monitor attribute with the provided information. It will
* have one or more String values.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param values The set of {@code String} values for this monitor
* attribute. It must not be {@code null} or empty.
*/
public MonitorAttribute(final String name, final String displayName,
final String description, final String[] values)
{
this(name, displayName, description, String.class, values);
}
/**
* Creates a new monitor attribute with the provided information.
*
* @param name The name used to identify this monitor attribute. It
* must not be {@code null}.
* @param displayName The human-readable display name for this monitor
* attribute. It must not be {@code null}.
* @param description A human-readable description for this monitor
* attribute. It may be {@code null} if no description
* is available.
* @param dataType The data type for this monitor attribute. It may be
* one of the following classes: Boolean, Date, Double,
* Long, and String. It must not be {@code null}.
* @param values The set of values for this monitor attribute. The
* data type for the values must correspond to the value
* of the {@code dataType} attribute. It must not be
* {@code null} or empty.
*/
private MonitorAttribute(final String name, final String displayName,
final String description, final Class dataType,
final Object[] values)
{
ensureNotNull(name, displayName, dataType, values);
ensureFalse(values.length == 0,
"MonitorAttribute.values must not be empty.");
this.name = name;
this.displayName = displayName;
this.description = description;
this.dataType = dataType;
this.values = values;
}
/**
* 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 the
* {@code MonitorEntry.getMonitorAttributes} method.
*
* @return The name used to identify this monitor attribute.
*/
public String getName()
{
return name;
}
/**
* Retrieves the human-readable display name for this monitor attribute.
*
* @return The human-readable display name for this monitor attribute.
*/
public String getDisplayName()
{
return displayName;
}
/**
* Retrieves the human-readable description for this monitor attribute, if
* available.
*
* @return The human-readable description for this monitor attribute, or
* {@code null} if none is available.
*/
public String getDescription()
{
return description;
}
/**
* 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.
*
* @return The class representing the data type for this monitor attribute.
*/
public Class getDataType()
{
return dataType;
}
/**
* Indicates whether this monitor attribute has multiple values.
*
* @return {@code true} if this monitor attribute has more than one value, or
* {@code false} if not.
*/
public boolean hasMultipleValues()
{
return (values.length > 1);
}
/**
* Retrieves the value for this monitor attribute as an {@code Object}. If it
* has multiple values, then the first will be returned.
*
* @return The value for this monitor attribute as an {@code Object}.
*/
public Object getValue()
{
return values[0];
}
/**
* Retrieves the set of values for this monitor attribute as a list of
* {@code Object}s.
*
* @return The set of values for this monitor attribute as a list of
* {@code Object}s.
*/
public List
