EntityRef

java.lang.Object
- org.jdom2.Content
- - org.jdom2.EntityRef

所有已实现的接口:

java.io.Serializable, java.lang.Cloneable, NamespaceAware

直接已知子类:

LocatedEntityRef
```
public class EntityRef
extends Content
```
An XML entity reference. Methods allow the user to manage its name, public id, and system id.

作者:

Brett McLaughlin, Jason Hunter, Philip Nelson, Rolf Lear

另请参阅:

序列化表格

嵌套类概要
- 从类继承的嵌套类/接口 org.jdom2.Content
  Content.CType

构造器概要

构造器
构造器和说明
`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.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`EntityRef`	`clone()` Return a deep clone of this instance.
`EntityRef`	`detach()` Detaches this child from its parent or does nothing if the child has no parent.
`java.lang.String`	`getName()` This returns the name of the `EntityRef`.
`Element`	`getParent()` Return this child's parent, or null if this child is currently not attached.
`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.

从类继承的方法 org.jdom2.Content
equals, getCType, getDocument, getNamespacesInherited, getNamespacesInScope, getNamespacesIntroduced, getParentElement, hashCode

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - EntityRef
```
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.
  - EntityRef
```
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.
    
    systemID - system id of the entity reference being constructed
    
    抛出:
    
    IllegalNameException - if the given name is not a legal XML name.
    
    IllegalDataException - if the given system ID is not a legal system literal.
  - 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.
    
    参数:
    
    name - String name of element.
    
    publicID - public id of the entity reference being constructed
    
    systemID - system id of the entity reference being constructed
    
    抛出:
    
    IllegalDataException - if the given system ID is not a legal system literal or the the given public ID is not a legal public ID
    
    IllegalNameException - if the given name is not a legal XML name.
- 方法详细资料
  - getName
```
public java.lang.String getName()
```
    This returns the name of the EntityRef.
    
    返回:
    
    String - entity name.
  - getValue
```
public java.lang.String getValue()
```
    Returns the empty string since entity references don't have an XPath 1.0 string value.
    
    指定者:
    
    getValue 在类中 Content
    
    返回:
    
    the empty string
  - 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.
    
    返回:
    
    public ID of this EntityRef
  - 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.
    
    返回:
    
    system ID of this EntityRef
  - setName
```
public EntityRef setName(java.lang.String name)
```
    This will set the name of this EntityRef.
    
    参数:
    
    name - new name of the entity
    
    返回:
    
    this EntityRef modified.
    
    抛出:
    
    IllegalNameException - if the given name is not a legal XML name.
  - setPublicID
```
public EntityRef setPublicID(java.lang.String publicID)
```
    This will set the public ID of this EntityRef.
    
    参数:
    
    publicID - new public id
    
    返回:
    
    this EntityRef modified.
    
    抛出:
    
    IllegalDataException - if the given public ID is not a legal public ID.
  - setSystemID
```
public EntityRef setSystemID(java.lang.String systemID)
```
    This will set the system ID of this EntityRef.
    
    参数:
    
    systemID - new system id
    
    返回:
    
    this EntityRef modified.
    
    抛出:
    
    IllegalDataException - if the given system ID is not a legal system literal.
  - toString
```
public java.lang.String toString()
```
    This returns a String representation of the EntityRef, suitable for debugging.
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    
    String - information about the EntityRef
  - detach
```
public EntityRef detach()
```
    从类复制的说明: Content
    
    Detaches this child from its parent or does nothing if the child has no parent.
    This method can be overridden by particular Content subclasses to return a specific type of Content (co-variant return type). All overriding subclasses must call super.detach();
    
    覆盖:
    
    detach 在类中 Content
    
    返回:
    
    this child detached
  - getParent
```
public Element getParent()
```
    从类复制的说明: Content
    
    Return this child's parent, or null if this child is currently not attached. The parent can be either an Element or a Document.
    This method can be overridden by particular Content subclasses to return a specific type of Parent (co-variant return type). All overriding subclasses must call super.getParent();
    
    覆盖:
    
    getParent 在类中 Content
    
    返回:
    
    this child's parent or null if none
  - clone
```
public EntityRef clone()
```
    Return a deep clone of this instance. Even if this instance has a parent, the returned clone will not.
    All JDOM core classes are Cloneable, and never throw CloneNotSupportedException. Additionally all Cloneable JDOM classes return the correct type of instance from this method and there is no need to cast the result (co-variant return vaue).
    Subclasses of this should still call super.clone() in their clone method.
    
    覆盖:
    
    clone 在类中 Content

类 EntityRef

嵌套类概要

从类继承的嵌套类/接口 org.jdom2.Content

构造器概要

方法概要

从类继承的方法 org.jdom2.Content

从类继承的方法 java.lang.Object

构造器详细资料

EntityRef

EntityRef

EntityRef

方法详细资料

getName

getValue

getPublicID

getSystemID

setName

setPublicID

setSystemID

toString

detach

getParent

clone