edu.uci.isr.xarch.hints
Interface IHints

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

HintsImpl

public interface IHints

extends IXArchElement

Interface for accessing objects of the Hints xsi:type in the hints namespace.

Author:

Automatically generated by xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Method Summary

void	addPropertyHint(IPropertyHint newPropertyHint) Add a propertyHint to this Hints.
void	addPropertyHints(Collection propertyHints) Add a collection of propertyHints to this Hints.
void	clearHintedThing() Clear the hintedThing from this Hints.
void	clearPropertyHints() Remove all propertyHints from this Hints.
Collection	getAllPropertyHints() Get all the propertyHints from this Hints.
IXMLLink	getHintedThing() Get the hintedThing from this Hints.
boolean	hasAllPropertyHints(Collection propertyHintsToCheck) Determine if this Hints contains each element in the given set of propertyHints.
boolean	hasHintedThing(IXMLLink hintedThingToCheck) Determine if this Hints has the given hintedThing
boolean	hasPropertyHint(IPropertyHint propertyHintToCheck) Determine if this Hints contains a given propertyHint.
Collection	hasPropertyHints(Collection propertyHintsToCheck) Determine if this Hints contains the given set of propertyHints.
boolean	isEquivalent(IHints HintsToCheck) Determine if another Hints is equivalent to this one, ignoring ID's.
void	removePropertyHint(IPropertyHint propertyHintToRemove) Remove the given propertyHint from this Hints.
void	removePropertyHints(Collection propertyHints) Remove all the given propertyHints from this Hints.
void	setHintedThing(IXMLLink value) Set the hintedThing for this Hints.

Methods inherited from interface edu.uci.isr.xarch.IXArchElement

cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

setHintedThing

public void setHintedThing(IXMLLink value)

Set the hintedThing for this Hints.

Parameters:

value - new hintedThing

clearHintedThing

public void clearHintedThing()

Clear the hintedThing from this Hints.

getHintedThing

public IXMLLink getHintedThing()

Get the hintedThing from this Hints.

Returns:

hintedThing

hasHintedThing

public boolean hasHintedThing(IXMLLink hintedThingToCheck)

Determine if this Hints has the given hintedThing

Parameters:

hintedThingToCheck - hintedThing to compare

Returns:

true if the hintedThings are equivalent, false otherwise

addPropertyHint

public void addPropertyHint(IPropertyHint newPropertyHint)

Add a propertyHint to this Hints.

Parameters:

newPropertyHint - propertyHint to add.

addPropertyHints

public void addPropertyHints(Collection propertyHints)

Add a collection of propertyHints to this Hints.

Parameters:

propertyHints - propertyHints to add.

clearPropertyHints

public void clearPropertyHints()

Remove all propertyHints from this Hints.

removePropertyHint

public void removePropertyHint(IPropertyHint propertyHintToRemove)

Remove the given propertyHint from this Hints. Matching is done by the isEquivalent(...) function.

Parameters:

propertyHintToRemove - propertyHint to remove.

removePropertyHints

public void removePropertyHints(Collection propertyHints)

Remove all the given propertyHints from this Hints. Matching is done by the isEquivalent(...) function.

Parameters:

propertyHints - propertyHint to remove.

getAllPropertyHints

public Collection getAllPropertyHints()

Get all the propertyHints from this Hints.

Returns:

all propertyHints in this Hints.

hasPropertyHint

public boolean hasPropertyHint(IPropertyHint propertyHintToCheck)

Determine if this Hints contains a given propertyHint.

Returns:

true if this Hints contains the given propertyHintToCheck, false otherwise.

hasPropertyHints

public Collection hasPropertyHints(Collection propertyHintsToCheck)

Determine if this Hints contains the given set of propertyHints.

Parameters:

propertyHintsToCheck - propertyHints to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in propertyHints was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllPropertyHints

public boolean hasAllPropertyHints(Collection propertyHintsToCheck)

Determine if this Hints contains each element in the given set of propertyHints.

Parameters:

propertyHintsToCheck - propertyHints to check for.

Returns:

true if every element in propertyHints is found in this Hints, false otherwise.

isEquivalent

public boolean isEquivalent(IHints HintsToCheck)

Determine if another Hints is equivalent to this one, ignoring ID's.

Parameters:

HintsToCheck - Hints to compare to this one.

Returns:

true if all the child elements of this Hints are equivalent, false otherwise.