com.xmlmind.xml.load

Class EntityRef

java.lang.Object

com.xmlmind.xml.load.EntityRef

All Implemented Interfaces:

Inclusion

public final class EntityRef
extends Object
implements Inclusion

Models an Inclusion which is a reference to an internal or external entity.

See Also:

XInclusion

Field Summary

Fields

Modifier and Type	Field and Description
String	name The name of the entity.
String	origin An ID uniquely identifying the place where this entity has been defined (external DTD subset, internal DTD subset of a given XML document, etc).

Constructor Summary

Constructors

Constructor and Description
EntityRef(String clipboardForm) Constructs an EntityRef initialized using specified clipboard form.
EntityRef(String name, String origin) Constructs an EntityRef initialized using specified values.

Method Summary

Modifier and Type	Method and Description
String	toClipboardForm() Returns a parseable string representation of this inclusion.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public final String name

The name of the entity.

origin

public final String origin

An ID uniquely identifying the place where this entity has been defined (external DTD subset, internal DTD subset of a given XML document, etc).

This unique ID may be used to prevent adding this property value to a node contained in a document where the corresponding entity has not been defined.

Constructor Detail

EntityRef

public EntityRef(String name,
                 String origin)

Constructs an EntityRef initialized using specified values.

EntityRef

public EntityRef(String clipboardForm)
          throws InclusionException

Constructs an EntityRef initialized using specified clipboard form.

Throws:

InclusionException

See Also:

toClipboardForm()

Method Detail

toClipboardForm

public String toClipboardForm()

Description copied from interface: Inclusion

Returns a parseable string representation of this inclusion.

Specified by:

toClipboardForm in interface Inclusion

toString

public String toString()

Overrides:

toString in class Object