org.polarsys.capella.common.helpers.validation.xml

Enum XHTMLEntities

java.lang.Object

java.lang.Enum<XHTMLEntities>

org.polarsys.capella.common.helpers.validation.xml.XHTMLEntities

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<XHTMLEntities>

public enum XHTMLEntities
extends java.lang.Enum<XHTMLEntities>

An enumeration of all allowed XHTML character entities. In most cases, the name of the enum literal is the name of the entity, but this cannot be guaranteed as there may be reserved words in java that collide with entity names (such as int), so you should always use entityName() to get the exact html entity name.

Enum Constant Summary

Enum Constants

Enum Constant and Description
_int
aacute
Aacute
acirc
Acirc
acute
aelig
AElig
agrave
Agrave
alefsym
alpha
Alpha
amp
and
ang
apos
aring
Aring
asymp
atilde
Atilde
auml
Auml
bdquo
beta
Beta
brvbar
bull
cap
ccedil
Ccedil
cedil
cent
chi
Chi
circ
clubs
cong
copy
crarr
cup
curren
dagger
Dagger
darr
dArr
deg
delta
Delta
diams
divide
eacute
Eacute
ecirc
Ecirc
egrave
Egrave
empty
emsp
ensp
epsilon
Epsilon
equiv
eta
Eta
eth
ETH
euml
Euml
euro
exist
fnof
forall
frac12
frac14
frac34
frasl
gamma
Gamma
ge
gt
harr
hArr
hearts
hellip
iacute
Iacute
icirc
Icirc
iexcl
igrave
Igrave
image
infin
iota
Iota
iquest
isin
iuml
Iuml
kappa
Kappa
lambda
Lambda
lang
laquo
larr
lArr
lceil
ldquo
le
lfloor
lowast
loz
lrm
lsaquo
lsquo
lt
macr
mdash
micro
middot
minus
mu
Mu
nabla
nbsp
ndash
ne
ni
not
notin
nsub
ntilde
Ntilde
nu
Nu
oacute
Oacute
ocirc
Ocirc
oelig
OElig
ograve
Ograve
oline
omega
Omega
omicron
Omicron
oplus
or
ordf
ordm
oslash
Oslash
otilde
Otilde
otimes
ouml
Ouml
para
part
permil
perp
phi
Phi
pi
Pi
piv
plusmn
pound
prime
Prime
prod
prop
psi
Psi
quot
radic
rang
raquo
rarr
rArr
rceil
rdquo
real
reg
rfloor
rho
Rho
rlm
rsaquo
rsquo
sbquo
scaron
Scaron
sdot
sect
shy
sigma
Sigma
sigmaf
sim
spades
sub
sube
sum
sup
sup1
sup2
sup3
supe
szlig
tau
Tau
there4
theta
Theta
thetasym
thinsp
thorn
THORN
tilde
times
trade
uacute
Uacute
uarr
uArr
ucirc
Ucirc
ugrave
Ugrave
uml
upsih
upsilon
Upsilon
uuml
Uuml
vellip
weierp
xi
Xi
yacute
Yacute
yen
yuml
Yuml
zeta
Zeta
zwj
zwnj

Method Summary

Modifier and Type	Method and Description
java.lang.String	asCharacterEntityRef()
java.lang.String	asHexadecimalEntityRef()
char	character() Returns the character that the entity represents.
java.lang.String	entityName()
boolean	isXML() Is this entity valid in any XML document, i.e.
static java.lang.String	unescapeHTMLRefs(java.lang.String input) Replace all html entity references in input with their corresponding character.
static java.lang.StringBuilder	unescapeHTMLRefs(java.lang.StringBuilder input) Replace all html entity references in input with their corresponding character.
static XHTMLEntities	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static XHTMLEntities[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

quot

public static final XHTMLEntities quot

amp

public static final XHTMLEntities amp

apos

public static final XHTMLEntities apos

lt

public static final XHTMLEntities lt

gt

public static final XHTMLEntities gt

nbsp

public static final XHTMLEntities nbsp

iexcl

public static final XHTMLEntities iexcl

cent

public static final XHTMLEntities cent

pound

public static final XHTMLEntities pound

curren

public static final XHTMLEntities curren

yen

public static final XHTMLEntities yen

brvbar

public static final XHTMLEntities brvbar

sect

public static final XHTMLEntities sect

uml

public static final XHTMLEntities uml

copy

public static final XHTMLEntities copy

ordf

public static final XHTMLEntities ordf

laquo

public static final XHTMLEntities laquo

not

public static final XHTMLEntities not

shy

public static final XHTMLEntities shy

reg

public static final XHTMLEntities reg

macr

public static final XHTMLEntities macr

deg

public static final XHTMLEntities deg

plusmn

public static final XHTMLEntities plusmn

sup2

public static final XHTMLEntities sup2

sup3

public static final XHTMLEntities sup3

acute

public static final XHTMLEntities acute

micro

public static final XHTMLEntities micro

para

public static final XHTMLEntities para

middot

public static final XHTMLEntities middot

cedil

public static final XHTMLEntities cedil

sup1

public static final XHTMLEntities sup1

ordm

public static final XHTMLEntities ordm

raquo

public static final XHTMLEntities raquo

frac14

public static final XHTMLEntities frac14

frac12

public static final XHTMLEntities frac12

frac34

public static final XHTMLEntities frac34

iquest

public static final XHTMLEntities iquest

Agrave

public static final XHTMLEntities Agrave

Aacute

public static final XHTMLEntities Aacute

Acirc

public static final XHTMLEntities Acirc

Atilde

public static final XHTMLEntities Atilde

Auml

public static final XHTMLEntities Auml

Aring

public static final XHTMLEntities Aring

AElig

public static final XHTMLEntities AElig

Ccedil

public static final XHTMLEntities Ccedil

Egrave

public static final XHTMLEntities Egrave

Eacute

public static final XHTMLEntities Eacute

Ecirc

public static final XHTMLEntities Ecirc

Euml

public static final XHTMLEntities Euml

Igrave

public static final XHTMLEntities Igrave

Iacute

public static final XHTMLEntities Iacute

Icirc

public static final XHTMLEntities Icirc

Iuml

public static final XHTMLEntities Iuml

ETH

public static final XHTMLEntities ETH

Ntilde

public static final XHTMLEntities Ntilde

Ograve

public static final XHTMLEntities Ograve

Oacute

public static final XHTMLEntities Oacute

Ocirc

public static final XHTMLEntities Ocirc

Otilde

public static final XHTMLEntities Otilde

Ouml

public static final XHTMLEntities Ouml

times

public static final XHTMLEntities times

Oslash

public static final XHTMLEntities Oslash

Ugrave

public static final XHTMLEntities Ugrave

Uacute

public static final XHTMLEntities Uacute

Ucirc

public static final XHTMLEntities Ucirc

Uuml

public static final XHTMLEntities Uuml

Yacute

public static final XHTMLEntities Yacute

THORN

public static final XHTMLEntities THORN

szlig

public static final XHTMLEntities szlig

agrave

public static final XHTMLEntities agrave

aacute

public static final XHTMLEntities aacute

acirc

public static final XHTMLEntities acirc

atilde

public static final XHTMLEntities atilde

auml

public static final XHTMLEntities auml

aring

public static final XHTMLEntities aring

aelig

public static final XHTMLEntities aelig

ccedil

public static final XHTMLEntities ccedil

egrave

public static final XHTMLEntities egrave

eacute

public static final XHTMLEntities eacute

ecirc

public static final XHTMLEntities ecirc

euml

public static final XHTMLEntities euml

igrave

public static final XHTMLEntities igrave

iacute

public static final XHTMLEntities iacute

icirc

public static final XHTMLEntities icirc

iuml

public static final XHTMLEntities iuml

eth

public static final XHTMLEntities eth

ntilde

public static final XHTMLEntities ntilde

ograve

public static final XHTMLEntities ograve

oacute

public static final XHTMLEntities oacute

ocirc

public static final XHTMLEntities ocirc

otilde

public static final XHTMLEntities otilde

ouml

public static final XHTMLEntities ouml

divide

public static final XHTMLEntities divide

oslash

public static final XHTMLEntities oslash

ugrave

public static final XHTMLEntities ugrave

uacute

public static final XHTMLEntities uacute

ucirc

public static final XHTMLEntities ucirc

uuml

public static final XHTMLEntities uuml

yacute

public static final XHTMLEntities yacute

thorn

public static final XHTMLEntities thorn

yuml

public static final XHTMLEntities yuml

OElig

public static final XHTMLEntities OElig

oelig

public static final XHTMLEntities oelig

Scaron

public static final XHTMLEntities Scaron

scaron

public static final XHTMLEntities scaron

Yuml

public static final XHTMLEntities Yuml

fnof

public static final XHTMLEntities fnof

circ

public static final XHTMLEntities circ

tilde

public static final XHTMLEntities tilde

Alpha

public static final XHTMLEntities Alpha

Beta

public static final XHTMLEntities Beta

Gamma

public static final XHTMLEntities Gamma

Delta

public static final XHTMLEntities Delta

Epsilon

public static final XHTMLEntities Epsilon

Zeta

public static final XHTMLEntities Zeta

Eta

public static final XHTMLEntities Eta

Theta

public static final XHTMLEntities Theta

Iota

public static final XHTMLEntities Iota

Kappa

public static final XHTMLEntities Kappa

Lambda

public static final XHTMLEntities Lambda

Mu

public static final XHTMLEntities Mu

Nu

public static final XHTMLEntities Nu

Xi

public static final XHTMLEntities Xi

Omicron

public static final XHTMLEntities Omicron

Pi

public static final XHTMLEntities Pi

Rho

public static final XHTMLEntities Rho

Sigma

public static final XHTMLEntities Sigma

Tau

public static final XHTMLEntities Tau

Upsilon

public static final XHTMLEntities Upsilon

Phi

public static final XHTMLEntities Phi

Chi

public static final XHTMLEntities Chi

Psi

public static final XHTMLEntities Psi

Omega

public static final XHTMLEntities Omega

alpha

public static final XHTMLEntities alpha

beta

public static final XHTMLEntities beta

gamma

public static final XHTMLEntities gamma

delta

public static final XHTMLEntities delta

epsilon

public static final XHTMLEntities epsilon

zeta

public static final XHTMLEntities zeta

eta

public static final XHTMLEntities eta

theta

public static final XHTMLEntities theta

iota

public static final XHTMLEntities iota

kappa

public static final XHTMLEntities kappa

lambda

public static final XHTMLEntities lambda

mu

public static final XHTMLEntities mu

nu

public static final XHTMLEntities nu

xi

public static final XHTMLEntities xi

omicron

public static final XHTMLEntities omicron

pi

public static final XHTMLEntities pi

rho

public static final XHTMLEntities rho

sigmaf

public static final XHTMLEntities sigmaf

sigma

public static final XHTMLEntities sigma

tau

public static final XHTMLEntities tau

upsilon

public static final XHTMLEntities upsilon

phi

public static final XHTMLEntities phi

chi

public static final XHTMLEntities chi

psi

public static final XHTMLEntities psi

omega

public static final XHTMLEntities omega

thetasym

public static final XHTMLEntities thetasym

upsih

public static final XHTMLEntities upsih

piv

public static final XHTMLEntities piv

ensp

public static final XHTMLEntities ensp

emsp

public static final XHTMLEntities emsp

thinsp

public static final XHTMLEntities thinsp

zwnj

public static final XHTMLEntities zwnj

zwj

public static final XHTMLEntities zwj

lrm

public static final XHTMLEntities lrm

rlm

public static final XHTMLEntities rlm

ndash

public static final XHTMLEntities ndash

mdash

public static final XHTMLEntities mdash

lsquo

public static final XHTMLEntities lsquo

rsquo

public static final XHTMLEntities rsquo

sbquo

public static final XHTMLEntities sbquo

ldquo

public static final XHTMLEntities ldquo

rdquo

public static final XHTMLEntities rdquo

bdquo

public static final XHTMLEntities bdquo

dagger

public static final XHTMLEntities dagger

Dagger

public static final XHTMLEntities Dagger

bull

public static final XHTMLEntities bull

hellip

public static final XHTMLEntities hellip

permil

public static final XHTMLEntities permil

prime

public static final XHTMLEntities prime

Prime

public static final XHTMLEntities Prime

lsaquo

public static final XHTMLEntities lsaquo

rsaquo

public static final XHTMLEntities rsaquo

oline

public static final XHTMLEntities oline

frasl

public static final XHTMLEntities frasl

euro

public static final XHTMLEntities euro

image

public static final XHTMLEntities image

weierp

public static final XHTMLEntities weierp

real

public static final XHTMLEntities real

trade

public static final XHTMLEntities trade

alefsym

public static final XHTMLEntities alefsym

larr

public static final XHTMLEntities larr

uarr

public static final XHTMLEntities uarr

rarr

public static final XHTMLEntities rarr

darr

public static final XHTMLEntities darr

harr

public static final XHTMLEntities harr

crarr

public static final XHTMLEntities crarr

lArr

public static final XHTMLEntities lArr

uArr

public static final XHTMLEntities uArr

rArr

public static final XHTMLEntities rArr

dArr

public static final XHTMLEntities dArr

hArr

public static final XHTMLEntities hArr

forall

public static final XHTMLEntities forall

part

public static final XHTMLEntities part

exist

public static final XHTMLEntities exist

empty

public static final XHTMLEntities empty

nabla

public static final XHTMLEntities nabla

isin

public static final XHTMLEntities isin

notin

public static final XHTMLEntities notin

ni

public static final XHTMLEntities ni

prod

public static final XHTMLEntities prod

sum

public static final XHTMLEntities sum

minus

public static final XHTMLEntities minus

lowast

public static final XHTMLEntities lowast

radic

public static final XHTMLEntities radic

prop

public static final XHTMLEntities prop

infin

public static final XHTMLEntities infin

ang

public static final XHTMLEntities ang

and

public static final XHTMLEntities and

or

public static final XHTMLEntities or

cap

public static final XHTMLEntities cap

cup

public static final XHTMLEntities cup

_int

public static final XHTMLEntities _int

there4

public static final XHTMLEntities there4

sim

public static final XHTMLEntities sim

cong

public static final XHTMLEntities cong

asymp

public static final XHTMLEntities asymp

ne

public static final XHTMLEntities ne

equiv

public static final XHTMLEntities equiv

le

public static final XHTMLEntities le

ge

public static final XHTMLEntities ge

sub

public static final XHTMLEntities sub

sup

public static final XHTMLEntities sup

nsub

public static final XHTMLEntities nsub

sube

public static final XHTMLEntities sube

supe

public static final XHTMLEntities supe

oplus

public static final XHTMLEntities oplus

otimes

public static final XHTMLEntities otimes

perp

public static final XHTMLEntities perp

sdot

public static final XHTMLEntities sdot

vellip

public static final XHTMLEntities vellip

lceil

public static final XHTMLEntities lceil

rceil

public static final XHTMLEntities rceil

lfloor

public static final XHTMLEntities lfloor

rfloor

public static final XHTMLEntities rfloor

lang

public static final XHTMLEntities lang

rang

public static final XHTMLEntities rang

loz

public static final XHTMLEntities loz

spades

public static final XHTMLEntities spades

clubs

public static final XHTMLEntities clubs

hearts

public static final XHTMLEntities hearts

diams

public static final XHTMLEntities diams

Method Detail

values

public static XHTMLEntities[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (XHTMLEntities c : XHTMLEntities.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static XHTMLEntities valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

asCharacterEntityRef

public java.lang.String asCharacterEntityRef()

Returns:

the named entity reference, e.g. ü

asHexadecimalEntityRef

public java.lang.String asHexadecimalEntityRef()

Returns:

the unicode ref in hexadecimal format (&#xHHHH;)

entityName

public java.lang.String entityName()

Returns:

the name of the character entity. This is preferrable to name(), as there may be entity names that collide with valid java enum literal names. In such cases, the literal name is the entity name prefixed with an underscore "_";

character

public char character()

Returns the character that the entity represents.

Returns:

isXML

public boolean isXML()

Is this entity valid in any XML document, i.e. one of the following: &amp; &quot; &apos; &lt; &gt;

unescapeHTMLRefs

public static java.lang.String unescapeHTMLRefs(java.lang.String input)

Replace all html entity references in input with their corresponding character. References for which isXML returns true are left alone.

Returns:

a new string with entity references replaced

unescapeHTMLRefs

public static java.lang.StringBuilder unescapeHTMLRefs(java.lang.StringBuilder input)

Replace all html entity references in input with their corresponding character. References for which isXML returns true are left alone.

Returns:

the argument string builder