org.cip4.jdflib.datatypes

Class JDFShapeRange

java.lang.Object

org.cip4.jdflib.datatypes.JDFRange

org.cip4.jdflib.datatypes.JDFShapeRange

All Implemented Interfaces:

JDFBaseDataTypes

public class JDFShapeRange
extends JDFRange

Nested Class Summary

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

JDFBaseDataTypes.EnumFitsValue

Field Summary

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
JDFShapeRange() constructs a shape pair range with all values set to 0.0 Double
JDFShapeRange(JDFShape x) constructs a JDFShapeRange, both values are equal ("from x to x")
JDFShapeRange(JDFShape xmin, JDFShape xmax) constructor a JDFShapeRange with two JDFShape values ("from xmin to xmax")
JDFShapeRange(JDFShapeRange r) copy constructor constructs a JDFShapeRange with the given JDFShapeRange
JDFShapeRange(String s) constructs a JDFShapeRange with the values of the given String

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other) equals - returns true if both JDFShapeRanges are equal otherwise false
JDFShape	getLeft() getLeft - gets the left JDFShape object of the range
protected Object	getLeftObject()
JDFShape	getLowerValue() getLowerValue - returns the lower value of the bounds
JDFShape	getRight() getRight - gets the right JDFShape object of the range
protected Object	getRightObject()
JDFShape	getUpperValue() getUpperValue - returns the upper value of the bounds
int	hashCode() hashCode complements equals() to fulfill the equals/hashCode contract
protected void	init(JDFShape x, JDFShape y) Initialization
protected boolean	inObjectRange(Object other)
boolean	inRange(JDFShape x) inRange - tests if the given x inside of this range
boolean	isPartOfRange(JDFRange ra) isPartOfRange - is range 'r' within this range?
boolean	isValid(String s) isValid - validate the given String
void	setLeft(JDFShape x) sets the left JDFShape object of the range
void	setRight(JDFShape x) sets the right JDFShape object of the range
String	toString() getString - returns the range as a String

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

getString

Methods inherited from class java.lang.Object

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

Constructor Detail

JDFShapeRange

public JDFShapeRange()

constructs a shape pair range with all values set to 0.0 Double

JDFShapeRange

public JDFShapeRange(JDFShape x)

constructs a JDFShapeRange, both values are equal ("from x to x")

Parameters:

x - the given JDFShape

JDFShapeRange

public JDFShapeRange(JDFShape xmin,
             JDFShape xmax)

constructor a JDFShapeRange with two JDFShape values ("from xmin to xmax")

Parameters:

xmin - the given min value

xmax - the given max value

JDFShapeRange

public JDFShapeRange(JDFShapeRange r)

copy constructor
constructs a JDFShapeRange with the given JDFShapeRange

Parameters:

r -

JDFShapeRange

public JDFShapeRange(String s)
              throws DataFormatException

constructs a JDFShapeRange with the values of the given String

Parameters:

s - the given string representation of the range

Throws:

DataFormatException - - if the String has not a valid format

Method Detail

init

protected void init(JDFShape x,
        JDFShape y)

Initialization

Parameters:

x - left boundary

y - right boundary

toString

public String toString()

getString - returns the range as a String

Overrides:

toString in class Object

Returns:

String - the range as a String

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

equals

public boolean equals(Object other)

equals - returns true if both JDFShapeRanges are equal otherwise false

Overrides:

equals in class JDFRange

Parameters:

other - Object to compare

Returns:

boolean - true if equal otherwise false

hashCode

public int hashCode()

hashCode complements equals() to fulfill the equals/hashCode contract

Overrides:

hashCode in class JDFRange

Returns:

int

inRange

public boolean inRange(JDFShape x)

inRange - tests if the given x inside of this range

Parameters:

x - comparison value

Returns:

boolean - true if x in range

isPartOfRange

public boolean isPartOfRange(JDFRange ra)

isPartOfRange - is range 'r' within this range?

Specified by:

isPartOfRange in class JDFRange

Parameters:

r - the range to test

Returns:

boolean - true if range 'r' is within this range, else false

getLeft

public JDFShape getLeft()

getLeft - gets the left JDFShape object of the range

Returns:

JDFShape x - the left JDFShape object of the range

getRight

public JDFShape getRight()

getRight - gets the right JDFShape object of the range

Returns:

JDFShape x - the right JDFShape object of the range

setLeft

public void setLeft(JDFShape x)

sets the left JDFShape object of the range

Parameters:

x - the left JDFShape object of the range

setRight

public void setRight(JDFShape x)

sets the right JDFShape object of the range

Parameters:

x - the right JDFShape object of the range

getUpperValue

public JDFShape getUpperValue()

getUpperValue - returns the upper value of the bounds

Returns:

JDFShape - the upper value of the range

getLowerValue

public JDFShape getLowerValue()

getLowerValue - returns the lower value of the bounds

Returns:

JDFShape - the lower value of the range

getRightObject

protected Object getRightObject()

Specified by:

getRightObject in class JDFRange

getLeftObject

protected Object getLeftObject()

Specified by:

getLeftObject in class JDFRange

inObjectRange

protected boolean inObjectRange(Object other)

Overrides:

inObjectRange in class JDFRange