java.lang.Object
- org.dom4j.tree.AbstractNode
- - org.dom4j.tree.AbstractEntity
  - - org.dom4j.tree.FlyweightEntity

All Implemented Interfaces:

Serializable, Cloneable, Entity, Node

Direct Known Subclasses:

DefaultEntity
```
public class FlyweightEntity
extends AbstractEntity
```
FlyweightEntity is a Flyweight pattern implementation of a singly linked, read-only XML entity.

This node could be shared across documents and elements though it does not support the parent relationship.

Often this node needs to be created and then the text content added later (for example in SAX) so this implementation allows a call to setText(java.lang.String) providing the entity has no text already.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected String name
The name of the Entity

protected String text
The text of the Entity
- Fields inherited from class org.dom4j.tree.AbstractNode
  NODE_TYPE_NAMES
- Fields inherited from interface org.dom4j.Node
  ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`FlyweightEntity()`	A default constructor for implementors to use.
	`FlyweightEntity(String name)`	Creates the `Entity` with the specified name
	`FlyweightEntity(String name, String text)`	Creates the `Entity` with the specified name and text.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Node`	`createXPathResult(Element parent)`
`String`	`getName()`	DOCUMENT ME!
`String`	`getText()`	DOCUMENT ME!
`void`	`setText(String text)`	sets the value of the entity if it is not defined yet otherwise an `UnsupportedOperationException` is thrown as this class is read only.

Methods inherited from class org.dom4j.tree.AbstractEntity
accept, asXML, getNodeType, getPath, getStringValue, getUniquePath, toString, write

Methods inherited from class org.dom4j.tree.AbstractNode
asXPathResult, clone, createPattern, createXPath, createXPathFilter, detach, getDocument, getDocumentFactory, getNodeTypeName, getParent, getPath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, supportsParent, valueOf

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dom4j.Node
asXPathResult, clone, createXPath, detach, getDocument, getNodeTypeName, getParent, getPath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, supportsParent, valueOf

- Field Detail
  - name
```
protected String name
```
    The name of the Entity
  - text
```
protected String text
```
    The text of the Entity
- Constructor Detail
  - FlyweightEntity
```
protected FlyweightEntity()
```
    A default constructor for implementors to use.
  - FlyweightEntity
```
public FlyweightEntity(String name)
```
    Creates the Entity with the specified name
    
    Parameters:
    
    name - is the name of the entity
  - FlyweightEntity
```
public FlyweightEntity(String name,
                       String text)
```
    Creates the Entity with the specified name and text.
    
    Parameters:
    
    name - is the name of the entity
    
    text - is the text of the entity
- Method Detail
  - getName
```
public String getName()
```
    DOCUMENT ME!
    
    Specified by:
    
    getName in interface Node
    
    Overrides:
    
    getName in class AbstractNode
    
    Returns:
    
    the name of the entity
  - getText
```
public String getText()
```
    DOCUMENT ME!
    
    Specified by:
    
    getText in interface Node
    
    Overrides:
    
    getText in class AbstractNode
    
    Returns:
    
    the text of the entity
  - setText
```
public void setText(String text)
```
    sets the value of the entity if it is not defined yet otherwise an UnsupportedOperationException is thrown as this class is read only.
    
    Specified by:
    
    setText in interface Node
    
    Overrides:
    
    setText in class AbstractNode
    
    Parameters:
    
    text - DOCUMENT ME!
    
    Throws:
    
    UnsupportedOperationException - DOCUMENT ME!
  - createXPathResult
```
protected Node createXPathResult(Element parent)
```
    Overrides:
    
    createXPathResult in class AbstractNode

Modifier and Type	Field	Description
`protected String`	`name`	The name of the `Entity`
`protected String`	`text`	The text of the `Entity`

Class FlyweightEntity

Field Summary

Fields inherited from class org.dom4j.tree.AbstractNode

Fields inherited from interface org.dom4j.Node

Constructor Summary

Method Summary

Methods inherited from class org.dom4j.tree.AbstractEntity

Methods inherited from class org.dom4j.tree.AbstractNode

Methods inherited from class java.lang.Object

Methods inherited from interface org.dom4j.Node

Field Detail

name

text

Constructor Detail

FlyweightEntity

FlyweightEntity

FlyweightEntity

Method Detail

getName

getText

setText

createXPathResult