org.cip4.jdflib.datatypes

Class JDFDurationRangeList

java.lang.Object

org.cip4.jdflib.datatypes.JDFRangeList

org.cip4.jdflib.datatypes.JDFDurationRangeList

All Implemented Interfaces:

JDFBaseDataTypes

public class JDFDurationRangeList
extends JDFRangeList

Nested Class Summary

Nested classes/interfaces inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes

JDFBaseDataTypes.EnumFitsValue

Field Summary

Fields inherited from class org.cip4.jdflib.datatypes.JDFRangeList

rangeList

Fields inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes

EPSILON, MAX_CMYK_COLOR, MAX_LAB_COLOR, MAX_MATRIX_DIMENSION, MAX_RECTANGLE_DIMENSION, MAX_RGB_COLOR, MAX_SHAPE_DIMENSION, MAX_XY_DIMENSION

Constructor Summary

Constructors

Constructor and Description
JDFDurationRangeList() empty constructor
JDFDurationRangeList(JDFDurationRangeList rl) constructs a JDFDurationRangeList from the given JDFDurationRangeList
JDFDurationRangeList(String s) constructs a JDFDurationRangeList from a given string

Method Summary

Methods

Modifier and Type	Method and Description
void	append(JDFDuration x) add an individual JDFDuration element
void	append(JDFDuration xMin, JDFDuration xMax) add a duration range defined by two dates xMin~xMax
void	append(JDFDurationRange r) add a duration range r =rMin~rMax
static JDFDurationRangeList	createDurationRangeList(String s) factory for JDFDurationRangeList that silently returns null in case of illegal strings
boolean	inRange(JDFDuration x) inRange - returns true if the given JDFDuration value is in one of the ranges of the range list
boolean	isOrdered() isOrdered - tests if 'this' is OrderedRangeList
boolean	isUniqueOrdered() isUniqueOrdered - tests if 'this' is UniqueOrdered RangeList
boolean	isValid(String s) isValid - validate the given String
void	setString(String s) setString - parse the given string and set the duration range list

Methods inherited from class org.cip4.jdflib.datatypes.JDFRangeList

at, begin, clear, elementAt, end, equals, erase, getString, getString, hashCode, isList, isPartOfRange, isPartOfRange, isUnique, remove, size, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JDFDurationRangeList

public JDFDurationRangeList()

empty constructor

JDFDurationRangeList

public JDFDurationRangeList(String s)
                     throws DataFormatException

constructs a JDFDurationRangeList from a given string

Parameters:

s - the given string

Throws:

DataFormatException - - if the String has not a valid format

JDFDurationRangeList

public JDFDurationRangeList(JDFDurationRangeList rl)

constructs a JDFDurationRangeList from the given JDFDurationRangeList

Parameters:

rl - the given JDFDurationRangeList

Method Detail

createDurationRangeList

public static JDFDurationRangeList createDurationRangeList(String s)

factory for JDFDurationRangeList that silently returns null in case of illegal strings

Parameters:

s - the string to parse

Returns:

the JDFDurationRangeList, null if s is not compatible

inRange

public boolean inRange(JDFDuration x)

inRange - returns true if the given JDFDuration value is in one of the ranges of the range list

Parameters:

x - the given JDFDuration (duration) value to compare

Returns:

boolean - true if in range otherwise false

setString

public void setString(String s)
               throws DataFormatException

setString - parse the given string and set the duration range list

Parameters:

s - the given string

Throws:

DataFormatException - - if the String has not a valid format

isValid

public boolean isValid(String s)

isValid - validate the given String

Parameters:

s - the given string

Returns:

boolean - false if the String has not a valid format

append

public void append(JDFDurationRange r)

add a duration range r =rMin~rMax

Parameters:

r - the Duration range to append to the list

append

public void append(JDFDuration xMin,
          JDFDuration xMax)

add a duration range defined by two dates xMin~xMax

Parameters:

xMin - the left value of the Duration range to append to the list

xMax - the right value of the Duration range to append to the list

append

public void append(JDFDuration x)

add an individual JDFDuration element

Parameters:

x - the left and right value of the Duration range to append to the list

isOrdered

public boolean isOrdered()

isOrdered - tests if 'this' is OrderedRangeList

Specified by:

isOrdered in class JDFRangeList

Returns:

boolean - true if 'this' is a OrdneredRangeList

isUniqueOrdered

public boolean isUniqueOrdered()

isUniqueOrdered - tests if 'this' is UniqueOrdered RangeList

Specified by:

isUniqueOrdered in class JDFRangeList

Returns:

boolean - true if 'this' is UniqueOrdered RangeList