Package org.ow2.authzforce.core.pdp.api.value

Class TimeValue

java.lang.Object

org.ow2.authzforce.core.pdp.api.value.SimpleValue<V>

org.ow2.authzforce.core.pdp.api.value.StringParseableValue<XMLGregorianCalendar>

org.ow2.authzforce.core.pdp.api.value.BaseTimeValue<TimeValue>

org.ow2.authzforce.core.pdp.api.value.TimeValue

All Implemented Interfaces:

Comparable<TimeValue>, AttributeValue, PrimitiveValue, Value

public final class TimeValue
extends BaseTimeValue<TimeValue>

Representation of a xs:time value. This class supports parsing xs:time values. All objects of this class are immutable and thread-safe.

The XMLGregorianCalendar returned by SimpleValue.getUnderlyingValue() have the following characteristics:

• XMLGregorianCalendar.getYear() always returns DatatypeConstants.FIELD_UNDEFINED
• XMLGregorianCalendar.getEon() and XMLGregorianCalendar.getEonAndYear() always return null
• XMLGregorianCalendar.getMonth() always returns DatatypeConstants.FIELD_UNDEFINED
• XMLGregorianCalendar.getDay() always returns DatatypeConstants.FIELD_UNDEFINED
• XMLGregorianCalendar.getYear() always returns DatatypeConstants.FIELD_UNDEFINED

Version:

$Id: $

Nested Class Summary

Nested classes/interfaces inherited from class org.ow2.authzforce.core.pdp.api.value.StringParseableValue

StringParseableValue.Factory<AV extends AttributeValue>

Nested classes/interfaces inherited from class org.ow2.authzforce.core.pdp.api.value.SimpleValue

SimpleValue.BaseFactory<AV extends AttributeValue>

Field Summary

Fields inherited from class org.ow2.authzforce.core.pdp.api.value.SimpleValue

value

Constructor Summary

Constructors

Constructor	Description
TimeValue(String time)	Creates a new TimeAttributeValue from a string representation of time

Method Summary

Modifier and Type	Method	Description
TimeValue	add(DurationValue<?> durationVal)	Add duration to this time
static TimeValue	getInstance(XMLGregorianCalendar timeCalendar)	Creates a new instance from a Calendar
TimeValue	subtract(DurationValue<?> durationVal)	Subtract duration to this time

Methods inherited from class org.ow2.authzforce.core.pdp.api.value.BaseTimeValue

compareTo, printXML

Methods inherited from class org.ow2.authzforce.core.pdp.api.value.StringParseableValue

getXmlAttributes

Methods inherited from class org.ow2.authzforce.core.pdp.api.value.SimpleValue

equals, getContent, getUnderlyingValue, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeValue

public TimeValue(String time)
          throws IllegalArgumentException

Creates a new TimeAttributeValue from a string representation of time

Parameters:

time - string representation of time

Throws:

IllegalArgumentException - if time is not a valid string representation of xs:time

Method Detail

getInstance

public static TimeValue getInstance(XMLGregorianCalendar timeCalendar)

Creates a new instance from a Calendar

Parameters:

timeCalendar - a XMLGregorianCalendar object representing the specified time; beware that this method creates an internal copy of timeCalendar (to prevent modification of timeCalendar and any external modification of the created instance's internal copy) before unsetting all date fields (year, month, day): e.g. for the year, calendarCopy.setYear(DatatypeConstants.FIELD_UNDEFINED)

Returns:

new instance

Throws:

IllegalArgumentException - if calendar == null

add

public TimeValue add(DurationValue<?> durationVal)

Add duration to this time

Specified by:

add in class BaseTimeValue<TimeValue>

Parameters:

durationVal - duration value

Returns:

this + durationVal

subtract

public TimeValue subtract(DurationValue<?> durationVal)

Subtract duration to this time

Specified by:

subtract in class BaseTimeValue<TimeValue>

Parameters:

durationVal - duration value

Returns:

this - durationVal