SpecialEntity (HtmlCleaner 2.21 API)

java.lang.Object
- org.htmlcleaner.SpecialEntity

public class SpecialEntity
extends Object

Constructor Summary

Constructors
Constructor Description

SpecialEntity(String key, int intCode, String htmlString, boolean htmlSpecialEntity)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`char`	`charValue()`
`String`	`getDecimalNCR()`
`String`	`getEscaped(boolean htmlEscaped)`
`String`	`getEscapedValue()`
`String`	`getEscapedXmlString()`
`String`	`getHexNCR()`
`String`	`getHtmlString()`
`String`	`getKey()`
`int`	`intValue()`
`boolean`	`isHtmlSpecialEntity()`

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

- Constructor Detail
  - SpecialEntity
```
public SpecialEntity(String key,
                     int intCode,
                     String htmlString,
                     boolean htmlSpecialEntity)
```
    Parameters:
    
    key - value between & and the ';' example 'amp' for '&'
    
    intCode -
    
    htmlString -
    
    htmlSpecialEntity - entity is affected by translateSpecialEntities property setting.
- Method Detail
  - getKey
```
public String getKey()
```
    Returns:
    
    the key
  - intValue
```
public int intValue()
```
    Returns:
    
    the intCode
  - getHtmlString
```
public String getHtmlString()
```
    Returns:
    
    the domString
  - getEscapedXmlString
```
public String getEscapedXmlString()
```
  - getEscaped
```
public String getEscaped(boolean htmlEscaped)
```
  - isHtmlSpecialEntity
```
public boolean isHtmlSpecialEntity()
```
    Returns:
    
    the translateSpecialEntities
  - charValue
```
public char charValue()
```
    Returns:
    
    intValue() cast to an char
  - getDecimalNCR
```
public String getDecimalNCR()
```
    Returns:
    
    Numeric Character Reference in decimal format
  - getHexNCR
```
public String getHexNCR()
```
    Returns:
    
    Numeric Character Reference in hex format
  - getEscapedValue
```
public String getEscapedValue()
```
    Returns:
    
    Escaped value of the entity