public class EntityRef
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
EntityRef
Defines an XML entity reference in Java.
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
name
The name of the
EntityRef |
protected java.lang.Object |
parent
Parent element or null if none
|
protected java.lang.String |
publicID
The PublicID of the
EntityRef |
protected java.lang.String |
systemID
The SystemID of the
EntityRef |
Modifier | Constructor and Description |
---|---|
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. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
This will return a clone of this
EntityRef . |
EntityRef |
detach()
This detaches the
Entity from its parent, or does nothing
if the Entity has no parent. |
boolean |
equals(java.lang.Object ob)
This tests for equality of this
Entity to the supplied
Object . |
Document |
getDocument()
|
java.lang.String |
getName()
This returns the name of the
EntityRef . |
Element |
getParent()
This will return the parent of this
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 . |
int |
hashCode()
This returns the hash code for this
Entity . |
EntityRef |
setName(java.lang.String name)
This will set the name of this
EntityRef . |
protected EntityRef |
setParent(Element parent)
This will set the parent of this
Entity . |
EntityRef |
setPublicID(java.lang.String newPublicID)
This will set the public ID of this
EntityRef . |
EntityRef |
setSystemID(java.lang.String newSystemID)
This will set the system ID of this
EntityRef . |
java.lang.String |
toString()
This returns a
String representation of the
EntityRef , suitable for debugging. |
protected java.lang.String name
EntityRef
protected java.lang.String publicID
EntityRef
protected java.lang.String systemID
EntityRef
protected java.lang.Object parent
protected EntityRef()
Default, no-args constructor for implementations to use if needed.
public EntityRef(java.lang.String name)
This will create a new EntityRef
with the supplied name.
name
- String
name of element.IllegalNameException
- if the given name is not a legal
XML name.public EntityRef(java.lang.String name, java.lang.String systemID)
This will create a new EntityRef
with the supplied name and system id.
name
- String
name of element.IllegalNameException
- if the given name is not a legal
XML name.IllegalDataException
- if the given system ID is not a legal
system literal.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.
name
- String
name of element.IllegalDataException
- if the given system ID is not a legal
system literal or the the given public ID is not a
legal public IDIllegalNameException
- if the given name is not a legal
XML name.public java.lang.Object clone()
This will return a clone of this EntityRef
.
clone
in class java.lang.Object
Object
- clone of this EntityRef
.public EntityRef detach()
This detaches the Entity
from its parent, or does nothing
if the Entity
has no parent.
Entity
- this Entity
modified.public final boolean equals(java.lang.Object ob)
This tests for equality of this Entity
to the supplied
Object
.
equals
in class java.lang.Object
ob
- Object
to compare to.boolean
- whether the Entity
is
equal to the supplied Object
.public Document getDocument()
This retrieves the owning
for
this Entity, or null if not a currently a member of a
Document
.
Document
Document
owning this Entity, or null.public java.lang.String getName()
This returns the name of the
EntityRef
.
String
- entity name.public Element getParent()
This will return the parent of this EntityRef
.
If there is no parent, then this returns null
.
EntityRef
public java.lang.String getPublicID()
This will return the publid ID of this EntityRef
.
If there is no public ID, then this returns null
.
EntityRef
public java.lang.String getSystemID()
This will return the system ID of this EntityRef
.
If there is no system ID, then this returns null
.
EntityRef
public final int hashCode()
This returns the hash code for this Entity
.
hashCode
in class java.lang.Object
int
- hash code.protected EntityRef setParent(Element parent)
This will set the parent of this Entity
.
parent
- Element
to be new parent.Entity
modified.public EntityRef setName(java.lang.String name)
This will set the name of this EntityRef
.
name
- new name of the entityEntityRef
modified.IllegalNameException
- if the given name is not a legal
XML name.public EntityRef setPublicID(java.lang.String newPublicID)
This will set the public ID of this EntityRef
.
newPublicID
- new public idEntityRef
modified.IllegalDataException
- if the given public ID is not a legal
public ID.public EntityRef setSystemID(java.lang.String newSystemID)
This will set the system ID of this EntityRef
.
newSystemID
- new system idEntityRef
modified.IllegalDataException
- if the given system ID is not a legal
system literal.public java.lang.String toString()
This returns a String
representation of the
EntityRef
, suitable for debugging.
toString
in class java.lang.Object
String
- information about the
EntityRef
Copyright (c) 2017 Software AG. All Rights Reserved.