org.rhq.core.domain.measurement
Enum AvailabilityType

java.lang.Object
  extended by java.lang.Enum<AvailabilityType>
      extended by org.rhq.core.domain.measurement.AvailabilityType
All Implemented Interfaces:
Serializable, Comparable<AvailabilityType>

public enum AvailabilityType
extends Enum<AvailabilityType>

The availability of a resource. This enum's ordinals are important - DOWN must be 0 and UP must be 1 - this is to support the ability to easily compute group availability through averaging the ordinals of multiple AvailabilityType instances.


Enum Constant Summary
DISABLED
          Resource is reporting but administratively disabled.
DOWN
          Resource is down for sure
UNKNOWN
          Resource avail can't be determined.
UP
          Resource is up
 
Method Summary
 String getName()
          A Java bean style getter to allow us to access the enum name from JSPs or Facelets (e.g.
static AvailabilityType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AvailabilityType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

DOWN

public static final AvailabilityType DOWN
Resource is down for sure


UP

public static final AvailabilityType UP
Resource is up


UNKNOWN

public static final AvailabilityType UNKNOWN
Resource avail can't be determined. Typically meaning the agent is down


DISABLED

public static final AvailabilityType DISABLED
Resource is reporting but administratively disabled. Put another way, it is expectedly down

Method Detail

values

public static AvailabilityType[] 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 (AvailabilityType c : AvailabilityType.values())
    System.out.println(c);

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

valueOf

public static AvailabilityType 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

getName

public String getName()
A Java bean style getter to allow us to access the enum name from JSPs or Facelets (e.g. ${resource.resourceType.category.name}).

Returns:
the enum name


Copyright © 2008-2012 Red Hat, Inc.. All Rights Reserved.