com.sun.xacml.attr
Class YearMonthDurationAttribute

java.lang.Object
  com.sun.xacml.attr.AttributeValue
      com.sun.xacml.attr.YearMonthDurationAttribute

All Implemented Interfaces:

Evaluatable

public class YearMonthDurationAttribute

extends AttributeValue

Representation of an xf:yearMonthDuration value. This class supports parsing xd:yearMonthDuration values. All objects of this class are immutable and thread-safe. The Date objects returned are not, but these objects are cloned before being returned.

Since:

1.0

Field Summary

static String

identifier Official name of this type

Constructor Summary

YearMonthDurationAttribute(boolean negative, long years, long months)
Creates a new YearMonthDurationAttribute that represents the duration supplied.

Method Summary

String	encode() Encodes the value in a form suitable for including in XML data like a request or an obligation.
boolean	equals(Object o) Returns true if the input is an instance of this class and if its value equals the value contained in this class.
static YearMonthDurationAttribute	getInstance(Node root) Returns a new YearMonthDurationAttribute that represents the xf:yearMonthDuration at a particular DOM node.
static YearMonthDurationAttribute	getInstance(String value) Returns a new YearMonthDurationAttribute that represents the xf:yearMonthDuration value indicated by the string provided.
long	getMonths() Gets the number of months.
long	getYears() Gets the number of years.
int	hashCode() Returns the hashcode value used to index and compare this object with others of the same type.
boolean	isNegative() Returns true if the duration is negative.
String	toString() Converts to a String representation.

Methods inherited from class com.sun.xacml.attr.AttributeValue

encode, encode, encodeWithTags, evaluate, evaluatesToBag, getChildren, getType, isBag

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

identifier

public static final String identifier

Official name of this type

See Also:

Constant Field Values

Constructor Detail

YearMonthDurationAttribute

public YearMonthDurationAttribute(boolean negative,
                                  long years,
                                  long months)
                           throws IllegalArgumentException

Creates a new YearMonthDurationAttribute that represents the duration supplied.

Parameters:

negative - true if the duration is negative, false otherwise

years - the number of years in the duration (must be positive)

months - the number of months in the duration (must be positive)

Throws:

IllegalArgumentException - if the total number of months exceeds Long.MAX_LONG or the number of months or years is negative

Method Detail

getInstance

public static YearMonthDurationAttribute getInstance(Node root)
                                              throws ParsingException

Returns a new YearMonthDurationAttribute that represents the xf:yearMonthDuration at a particular DOM node.

Parameters:

root - the Node that contains the desired value

Returns:

a new YearMonthDurationAttribute representing the appropriate value

Throws:

ParsingException - if any problems occurred while parsing

getInstance

public static YearMonthDurationAttribute getInstance(String value)
                                              throws ParsingException

Returns a new YearMonthDurationAttribute that represents the xf:yearMonthDuration value indicated by the string provided.

Parameters:

value - a string representing the desired value

Returns:

a new YearMonthDurationAttribute representing the desired value

Throws:

ParsingException - if any problems occurred while parsing

isNegative

public boolean isNegative()

Returns true if the duration is negative.

Returns:

true if the duration is negative, false otherwise

getYears

public long getYears()

Gets the number of years.

Returns:

the number of years

getMonths

public long getMonths()

Gets the number of months.

Returns:

the number of months

equals

public boolean equals(Object o)

Returns true if the input is an instance of this class and if its value equals the value contained in this class.

Parameters:

o - the object to compare

Returns:

true if this object and the input represent the same value

hashCode

public int hashCode()

Returns the hashcode value used to index and compare this object with others of the same type. Typically this is the hashcode of the backing data object.

Returns:

the object's hashcode value

toString

public String toString()

Converts to a String representation.

Returns:

the String representation

encode

public String encode()

Encodes the value in a form suitable for including in XML data like a request or an obligation. This must return a value that could in turn be used by the factory to create a new instance with the same value.

Specified by:

encode in class AttributeValue

Returns:

a String form of the value