SpecialEntity

java.lang.Object
- org.htmlcleaner.SpecialEntity

public class SpecialEntity
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field	Description
`private java.lang.String`	`escapedXmlString`
`private boolean`	`htmlSpecialEntity`
`private java.lang.String`	`htmlString`
`private int`	`intCode`
`private java.lang.String`	`key`

Constructor Summary

Constructors
Constructor Description

SpecialEntity(java.lang.String key, int intCode, java.lang.String htmlString, boolean htmlSpecialEntity)

Method Summary

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

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

Field Detail

key
```
private final java.lang.String key
```

intCode
```
private final int intCode
```

htmlString

private final java.lang.String htmlString

htmlSpecialEntity
```
private boolean htmlSpecialEntity
```

escapedXmlString

private final java.lang.String escapedXmlString

Constructor Detail
- SpecialEntity
```
public SpecialEntity(java.lang.String key,
                     int intCode,
                     java.lang.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 java.lang.String getKey()
```
  Returns:
  
  the key
- intValue
```
public int intValue()
```
  Returns:
  
  the intCode
- getHtmlString
```
public java.lang.String getHtmlString()
```
  Returns:
  
  the domString
- getEscapedXmlString
```
public java.lang.String getEscapedXmlString()
```
- getEscaped
```
public java.lang.String getEscaped(boolean htmlEscaped)
```
- isHtmlSpecialEntity
```
public boolean isHtmlSpecialEntity()
```
  Returns:
  
  the translateSpecialEntities
- charValue
```
public char charValue()
```
  Returns:
  
  intValue() cast to an char
- getDecimalNCR
```
public java.lang.String getDecimalNCR()
```
  Returns:
  
  Numeric Character Reference in decimal format
- getHexNCR
```
public java.lang.String getHexNCR()
```
  Returns:
  
  Numeric Character Reference in hex format
- getEscapedValue
```
public java.lang.String getEscapedValue()
```
  Returns:
  
  Escaped value of the entity