Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> [ jdom overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jdom
Class EntityRef  

java.lang.Object
  org.jdom.Content
      org.jdom.EntityRef

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

---

public class EntityRef

extends Content

An XML entity reference. Methods allow the user to manage its name, public id, and system id.

Version:

$Revision: 1.21 $, $Date: 2004/02/27 11:32:57 $

---

Field Summary
private static java.lang.String	CVS_ID
protected  java.lang.String	name           The name of the EntityRef
protected  java.lang.String	publicID           The PublicID of the EntityRef
protected  java.lang.String	systemID           The SystemID of the EntityRef

 

Fields inherited from class org.jdom.Content

parent

 

Constructor Summary
protected	EntityRef()           Default, no-args constructor for implementations to use if needed.
	EntityRef(java.lang.String name)           This will create a new EntityRef with the supplied name.
	EntityRef(java.lang.String name, java.lang.String systemID)           This will create a new EntityRef with the supplied name and system id.
	EntityRef(java.lang.String name, java.lang.String publicID, java.lang.String systemID)           This will create a new EntityRef with the supplied name, public id, and system id.

 

Method Summary
java.lang.String	getName()           This returns the name of the EntityRef.
java.lang.String	getPublicID()           This will return the publid ID of this EntityRef.
java.lang.String	getSystemID()           This will return the system ID of this EntityRef.
java.lang.String	getValue()           Returns the empty string since entity references don't have an XPath 1.0 string value.
EntityRef	setName(java.lang.String name)           This will set the name of this EntityRef.
EntityRef	setPublicID(java.lang.String publicID)           This will set the public ID of this EntityRef.
EntityRef	setSystemID(java.lang.String systemID)           This will set the system ID of this EntityRef.
java.lang.String	toString()           This returns a String representation of the EntityRef, suitable for debugging.

 

Methods inherited from class org.jdom.Content

clone, detach, equals, getDocument, getParent, getParentElement, hashCode, setParent

 

Methods inherited from class java.lang.Object

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

 

Field Detail

CVS_ID

private static final java.lang.String CVS_ID

See Also:

Constant Field Values

---

name

protected java.lang.String name

The name of the EntityRef

---

publicID

protected java.lang.String publicID

The PublicID of the EntityRef

---

systemID

protected java.lang.String systemID

The SystemID of the EntityRef

Constructor Detail

EntityRef

protected EntityRef()

Default, no-args constructor for implementations to use if needed.

---

EntityRef

public EntityRef(java.lang.String name)

This will create a new EntityRef with the supplied name.

---

EntityRef

public EntityRef(java.lang.String name,
                 java.lang.String systemID)

This will create a new EntityRef with the supplied name and system id.

---

EntityRef

public EntityRef(java.lang.String name,
                 java.lang.String publicID,
                 java.lang.String systemID)

This will create a new EntityRef with the supplied name, public id, and system id.

Method Detail

getName

public java.lang.String getName()

This returns the name of the EntityRef.

---

getValue

public java.lang.String getValue()

Returns the empty string since entity references don't have an XPath 1.0 string value.

Specified by:

getValue in class Content

---

getPublicID

public java.lang.String getPublicID()

This will return the publid ID of this EntityRef. If there is no public ID, then this returns null.

---

getSystemID

public java.lang.String getSystemID()

This will return the system ID of this EntityRef. If there is no system ID, then this returns null.

---

setName

public EntityRef setName(java.lang.String name)

This will set the name of this EntityRef.

---

setPublicID

public EntityRef setPublicID(java.lang.String publicID)

This will set the public ID of this EntityRef.

---

setSystemID

public EntityRef setSystemID(java.lang.String systemID)

This will set the system ID of this EntityRef.

---

toString

public java.lang.String toString()

This returns a String representation of the EntityRef, suitable for debugging.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> [ jdom overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---