org.netbeans.modules.xml.xam
Class AbstractReference<T extends Referenceable>

java.lang.Object
  org.netbeans.modules.xml.xam.AbstractReference<T>

All Implemented Interfaces:

Reference<T>

Direct Known Subclasses:

AbstractNamedComponentReference

public abstract class AbstractReference<T extends Referenceable>
extends Object
implements Reference<T>

Represents reference to a component. On writing, this indirection help serialize the referenced component as an attribute string value. On reading, the referenced can be resolved on demand.

Note: Client code should always check for brokeness before access the referenced.

Field Summary

protected String

refString

Constructor Summary

AbstractReference(Class<T> referencedType, AbstractComponent parent, String ref)
Constructor for reading.

AbstractReference(T referenced, Class<T> referencedType, AbstractComponent parent)
Constructor for writing.

Method Summary

boolean	equals(Object obj)
protected AbstractComponent	getParent()
protected T	getReferenced() Access method for referenced.
String	getRefString()
Class<T>	getType() Returns type of the referenced component
int	hashCode()
boolean	isBroken() Returns true if the reference cannot be resolved in the current document
boolean	references(T target) Returns true if this reference refers to the target component.
protected void	setReferenced(T referenced) Accessor method for referenced.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netbeans.modules.xml.xam.Reference

get

Field Detail

refString

protected String refString

Constructor Detail

AbstractReference

public AbstractReference(T referenced,
                         Class<T> referencedType,
                         AbstractComponent parent)

Constructor for writing.

Parameters:

referenced - the component being referenced

referencedType - type of the referenced component

parent - referencing component on which the referenced is serialized as an attribute string value.

AbstractReference

public AbstractReference(Class<T> referencedType,
                         AbstractComponent parent,
                         String ref)

Constructor for reading.

Parameters:

referencedType - type of the referenced component

parent - referencing component on which the referenced is serialized as an attribute string value.

ref - the string value used in resolving.

Method Detail

getReferenced

protected T getReferenced()

Access method for referenced.

setReferenced

protected void setReferenced(T referenced)

Accessor method for referenced.

getType

public Class<T> getType()

Returns type of the referenced component

Specified by:

getType in interface Reference<T extends Referenceable>

isBroken

public boolean isBroken()

Returns true if the reference cannot be resolved in the current document

Specified by:

isBroken in interface Reference<T extends Referenceable>

references

public boolean references(T target)

Returns true if this reference refers to the target component.

Specified by:

references in interface Reference<T extends Referenceable>

getRefString

public String getRefString()

Specified by:

getRefString in interface Reference<T extends Referenceable>

Returns:

string to use in persiting the reference as attribute value of the containing component

toString

public String toString()

Overrides:

toString in class Object

getParent

protected AbstractComponent getParent()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object