Package com.helger.html.entity
Enum EHTMLEntity
- java.lang.Object
-
- java.lang.Enum<EHTMLEntity>
-
- com.helger.html.entity.EHTMLEntity
-
- All Implemented Interfaces:
IHTMLEntity,Serializable,Comparable<EHTMLEntity>
@CodingStyleguideUnaware public enum EHTMLEntity extends Enum<EHTMLEntity> implements IHTMLEntity
Contains some predefined entities.- Author:
- Philip Helger
-
-
Enum Constant Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description chargetChar()CharactergetCharObj()StringgetCharString()static com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>getCharStringToEntityRefMap()static com.helger.commons.collection.impl.ICommonsOrderedMap<Character,EHTMLEntity>getCharToEntityMap()static com.helger.commons.collection.impl.ICommonsOrderedMap<Character,String>getCharToEntityRefMap()StringgetDescription()StringgetEntityName()StringgetEntityReference()static com.helger.commons.collection.impl.ICommonsOrderedMap<String,Character>getEntityRefToCharMap()static com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>getEntityRefToCharStringMap()static com.helger.commons.collection.impl.ICommonsOrderedMap<String,EHTMLEntity>getEntityRefToEntityMap()static EHTMLEntitygetFromCharOrNull(char c)Get the predefined HTML entity to be used to represent the passed character.static EHTMLEntitygetFromEntityReferenceOrNull(String sEntityReference)Get the predefined HTML entity for the specified entity reference string is valid.static StringhtmlEscape(String sSource)Perform an HTML escape on the passed string.static booleanisValidEntityChar(char c)Check if the passed character can be presented by an entity reference string.static booleanisValidEntityReference(String sEntityReference)Check if the passed entity reference string is valid.StringtoString()static EHTMLEntityvalueOf(String name)Returns the enum constant of this type with the specified name.static EHTMLEntity[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
amp
public static final EHTMLEntity amp
-
gt
public static final EHTMLEntity gt
-
lt
public static final EHTMLEntity lt
-
quot
public static final EHTMLEntity quot
-
apos
public static final EHTMLEntity apos
-
nbsp
public static final EHTMLEntity nbsp
-
iexcl
public static final EHTMLEntity iexcl
-
cent
public static final EHTMLEntity cent
-
pound
public static final EHTMLEntity pound
-
curren
public static final EHTMLEntity curren
-
yen
public static final EHTMLEntity yen
-
brvbar
public static final EHTMLEntity brvbar
-
sect
public static final EHTMLEntity sect
-
uml
public static final EHTMLEntity uml
-
copy
public static final EHTMLEntity copy
-
ordf
public static final EHTMLEntity ordf
-
laquo
public static final EHTMLEntity laquo
-
not
public static final EHTMLEntity not
-
shy
public static final EHTMLEntity shy
-
reg
public static final EHTMLEntity reg
-
macr
public static final EHTMLEntity macr
-
deg
public static final EHTMLEntity deg
-
plusmn
public static final EHTMLEntity plusmn
-
sup2
public static final EHTMLEntity sup2
-
sup3
public static final EHTMLEntity sup3
-
acute
public static final EHTMLEntity acute
-
micro
public static final EHTMLEntity micro
-
para
public static final EHTMLEntity para
-
middot
public static final EHTMLEntity middot
-
cedil
public static final EHTMLEntity cedil
-
sup1
public static final EHTMLEntity sup1
-
ordm
public static final EHTMLEntity ordm
-
raquo
public static final EHTMLEntity raquo
-
frac14
public static final EHTMLEntity frac14
-
frac12
public static final EHTMLEntity frac12
-
frac34
public static final EHTMLEntity frac34
-
iquest
public static final EHTMLEntity iquest
-
times
public static final EHTMLEntity times
-
divide
public static final EHTMLEntity divide
-
Agrave
public static final EHTMLEntity Agrave
-
Aacute
public static final EHTMLEntity Aacute
-
Acirc
public static final EHTMLEntity Acirc
-
Atilde
public static final EHTMLEntity Atilde
-
Auml
public static final EHTMLEntity Auml
-
Aring
public static final EHTMLEntity Aring
-
AElig
public static final EHTMLEntity AElig
-
Ccedil
public static final EHTMLEntity Ccedil
-
Egrave
public static final EHTMLEntity Egrave
-
Eacute
public static final EHTMLEntity Eacute
-
Ecirc
public static final EHTMLEntity Ecirc
-
Euml
public static final EHTMLEntity Euml
-
Igrave
public static final EHTMLEntity Igrave
-
Iacute
public static final EHTMLEntity Iacute
-
Icirc
public static final EHTMLEntity Icirc
-
Iuml
public static final EHTMLEntity Iuml
-
ETH
public static final EHTMLEntity ETH
-
Ntilde
public static final EHTMLEntity Ntilde
-
Ograve
public static final EHTMLEntity Ograve
-
Oacute
public static final EHTMLEntity Oacute
-
Ocirc
public static final EHTMLEntity Ocirc
-
Otilde
public static final EHTMLEntity Otilde
-
Ouml
public static final EHTMLEntity Ouml
-
Oslash
public static final EHTMLEntity Oslash
-
Ugrave
public static final EHTMLEntity Ugrave
-
Uacute
public static final EHTMLEntity Uacute
-
Ucirc
public static final EHTMLEntity Ucirc
-
Uuml
public static final EHTMLEntity Uuml
-
Yacute
public static final EHTMLEntity Yacute
-
THORN
public static final EHTMLEntity THORN
-
szlig
public static final EHTMLEntity szlig
-
agrave
public static final EHTMLEntity agrave
-
aacute
public static final EHTMLEntity aacute
-
acirc
public static final EHTMLEntity acirc
-
atilde
public static final EHTMLEntity atilde
-
auml
public static final EHTMLEntity auml
-
aring
public static final EHTMLEntity aring
-
aelig
public static final EHTMLEntity aelig
-
ccedil
public static final EHTMLEntity ccedil
-
egrave
public static final EHTMLEntity egrave
-
eacute
public static final EHTMLEntity eacute
-
ecirc
public static final EHTMLEntity ecirc
-
euml
public static final EHTMLEntity euml
-
igrave
public static final EHTMLEntity igrave
-
iacute
public static final EHTMLEntity iacute
-
icirc
public static final EHTMLEntity icirc
-
iuml
public static final EHTMLEntity iuml
-
eth
public static final EHTMLEntity eth
-
ntilde
public static final EHTMLEntity ntilde
-
ograve
public static final EHTMLEntity ograve
-
oacute
public static final EHTMLEntity oacute
-
ocirc
public static final EHTMLEntity ocirc
-
otilde
public static final EHTMLEntity otilde
-
ouml
public static final EHTMLEntity ouml
-
oslash
public static final EHTMLEntity oslash
-
ugrave
public static final EHTMLEntity ugrave
-
uacute
public static final EHTMLEntity uacute
-
ucirc
public static final EHTMLEntity ucirc
-
uuml
public static final EHTMLEntity uuml
-
yacute
public static final EHTMLEntity yacute
-
thorn
public static final EHTMLEntity thorn
-
yuml
public static final EHTMLEntity yuml
-
forall
public static final EHTMLEntity forall
-
part
public static final EHTMLEntity part
-
exist
public static final EHTMLEntity exist
-
empty
public static final EHTMLEntity empty
-
nabla
public static final EHTMLEntity nabla
-
isin
public static final EHTMLEntity isin
-
notin
public static final EHTMLEntity notin
-
ni
public static final EHTMLEntity ni
-
prod
public static final EHTMLEntity prod
-
sum
public static final EHTMLEntity sum
-
minus
public static final EHTMLEntity minus
-
lowast
public static final EHTMLEntity lowast
-
radic
public static final EHTMLEntity radic
-
prop
public static final EHTMLEntity prop
-
infin
public static final EHTMLEntity infin
-
ang
public static final EHTMLEntity ang
-
and
public static final EHTMLEntity and
-
or
public static final EHTMLEntity or
-
cap
public static final EHTMLEntity cap
-
cup
public static final EHTMLEntity cup
-
int_
public static final EHTMLEntity int_
-
there4
public static final EHTMLEntity there4
-
sim
public static final EHTMLEntity sim
-
cong
public static final EHTMLEntity cong
-
asymp
public static final EHTMLEntity asymp
-
ne
public static final EHTMLEntity ne
-
equiv
public static final EHTMLEntity equiv
-
le
public static final EHTMLEntity le
-
ge
public static final EHTMLEntity ge
-
sub
public static final EHTMLEntity sub
-
sup
public static final EHTMLEntity sup
-
nsub
public static final EHTMLEntity nsub
-
sube
public static final EHTMLEntity sube
-
supe
public static final EHTMLEntity supe
-
oplus
public static final EHTMLEntity oplus
-
otimes
public static final EHTMLEntity otimes
-
perp
public static final EHTMLEntity perp
-
sdot
public static final EHTMLEntity sdot
-
Alpha
public static final EHTMLEntity Alpha
-
Beta
public static final EHTMLEntity Beta
-
Gamma
public static final EHTMLEntity Gamma
-
Delta
public static final EHTMLEntity Delta
-
Epsilon
public static final EHTMLEntity Epsilon
-
Zeta
public static final EHTMLEntity Zeta
-
Eta
public static final EHTMLEntity Eta
-
Theta
public static final EHTMLEntity Theta
-
Iota
public static final EHTMLEntity Iota
-
Kappa
public static final EHTMLEntity Kappa
-
Lambda
public static final EHTMLEntity Lambda
-
Mu
public static final EHTMLEntity Mu
-
Nu
public static final EHTMLEntity Nu
-
Xi
public static final EHTMLEntity Xi
-
Omicron
public static final EHTMLEntity Omicron
-
Pi
public static final EHTMLEntity Pi
-
Rho
public static final EHTMLEntity Rho
-
Sigma
public static final EHTMLEntity Sigma
-
Tau
public static final EHTMLEntity Tau
-
Upsilon
public static final EHTMLEntity Upsilon
-
Phi
public static final EHTMLEntity Phi
-
Chi
public static final EHTMLEntity Chi
-
Psi
public static final EHTMLEntity Psi
-
Omega
public static final EHTMLEntity Omega
-
alpha
public static final EHTMLEntity alpha
-
beta
public static final EHTMLEntity beta
-
gamma
public static final EHTMLEntity gamma
-
delta
public static final EHTMLEntity delta
-
epsilon
public static final EHTMLEntity epsilon
-
zeta
public static final EHTMLEntity zeta
-
eta
public static final EHTMLEntity eta
-
theta
public static final EHTMLEntity theta
-
iota
public static final EHTMLEntity iota
-
kappa
public static final EHTMLEntity kappa
-
lambda
public static final EHTMLEntity lambda
-
mu
public static final EHTMLEntity mu
-
nu
public static final EHTMLEntity nu
-
xi
public static final EHTMLEntity xi
-
omicron
public static final EHTMLEntity omicron
-
pi
public static final EHTMLEntity pi
-
rho
public static final EHTMLEntity rho
-
sigmaf
public static final EHTMLEntity sigmaf
-
sigma
public static final EHTMLEntity sigma
-
tau
public static final EHTMLEntity tau
-
upsilon
public static final EHTMLEntity upsilon
-
phi
public static final EHTMLEntity phi
-
chi
public static final EHTMLEntity chi
-
psi
public static final EHTMLEntity psi
-
omega
public static final EHTMLEntity omega
-
thetasym
public static final EHTMLEntity thetasym
-
upsih
public static final EHTMLEntity upsih
-
piv
public static final EHTMLEntity piv
-
weierp
public static final EHTMLEntity weierp
-
image
public static final EHTMLEntity image
-
real
public static final EHTMLEntity real
-
trade
public static final EHTMLEntity trade
-
alefsym
public static final EHTMLEntity alefsym
-
larr
public static final EHTMLEntity larr
-
uarr
public static final EHTMLEntity uarr
-
rarr
public static final EHTMLEntity rarr
-
darr
public static final EHTMLEntity darr
-
harr
public static final EHTMLEntity harr
-
crarr
public static final EHTMLEntity crarr
-
lArr
public static final EHTMLEntity lArr
-
uArr
public static final EHTMLEntity uArr
-
rArr
public static final EHTMLEntity rArr
-
dArr
public static final EHTMLEntity dArr
-
hArr
public static final EHTMLEntity hArr
-
OElig
public static final EHTMLEntity OElig
-
oelig
public static final EHTMLEntity oelig
-
Scaron
public static final EHTMLEntity Scaron
-
scaron
public static final EHTMLEntity scaron
-
Yuml
public static final EHTMLEntity Yuml
-
fnof
public static final EHTMLEntity fnof
-
circ
public static final EHTMLEntity circ
-
tilde
public static final EHTMLEntity tilde
-
ensp
public static final EHTMLEntity ensp
-
emsp
public static final EHTMLEntity emsp
-
thinsp
public static final EHTMLEntity thinsp
-
zwnj
public static final EHTMLEntity zwnj
-
zwj
public static final EHTMLEntity zwj
-
lrm
public static final EHTMLEntity lrm
-
rlm
public static final EHTMLEntity rlm
-
ndash
public static final EHTMLEntity ndash
-
mdash
public static final EHTMLEntity mdash
-
lsquo
public static final EHTMLEntity lsquo
-
rsquo
public static final EHTMLEntity rsquo
-
sbquo
public static final EHTMLEntity sbquo
-
ldquo
public static final EHTMLEntity ldquo
-
rdquo
public static final EHTMLEntity rdquo
-
bdquo
public static final EHTMLEntity bdquo
-
dagger
public static final EHTMLEntity dagger
-
Dagger
public static final EHTMLEntity Dagger
-
bull
public static final EHTMLEntity bull
-
hellip
public static final EHTMLEntity hellip
-
permil
public static final EHTMLEntity permil
-
prime
public static final EHTMLEntity prime
-
Prime
public static final EHTMLEntity Prime
-
lsaquo
public static final EHTMLEntity lsaquo
-
rsaquo
public static final EHTMLEntity rsaquo
-
oline
public static final EHTMLEntity oline
-
euro
public static final EHTMLEntity euro
-
lceil
public static final EHTMLEntity lceil
-
rceil
public static final EHTMLEntity rceil
-
lfloor
public static final EHTMLEntity lfloor
-
rfloor
public static final EHTMLEntity rfloor
-
loz
public static final EHTMLEntity loz
-
spades
public static final EHTMLEntity spades
-
clubs
public static final EHTMLEntity clubs
-
hearts
public static final EHTMLEntity hearts
-
diams
public static final EHTMLEntity diams
-
frasl
public static final EHTMLEntity frasl
-
lang
public static final EHTMLEntity lang
-
rang
public static final EHTMLEntity rang
-
-
Method Detail
-
values
public static EHTMLEntity[] 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 (EHTMLEntity c : EHTMLEntity.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EHTMLEntity valueOf(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:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getEntityName
@Nonnull @Nonempty public String getEntityName()
- Specified by:
getEntityNamein interfaceIHTMLEntity- Returns:
- The name of the entity. E.g.
nbsp
-
getEntityReference
@Nonnull @Nonempty public String getEntityReference()
- Specified by:
getEntityReferencein interfaceIHTMLEntity- Returns:
- The reference to the entity. E.g.
-
getChar
public char getChar()
- Returns:
- The source character matching the entity.
-
getCharObj
@Nonnull public Character getCharObj()
- Returns:
- The source character object matching the entity. Never
null.
-
getCharString
@Nonnull public String getCharString()
- Returns:
- The source character string matching the entity.
-
toString
public String toString()
- Overrides:
toStringin classEnum<EHTMLEntity>
-
isValidEntityReference
public static boolean isValidEntityReference(@Nullable String sEntityReference)
Check if the passed entity reference string is valid.- Parameters:
sEntityReference- The string to be checked (e.g."–")- Returns:
trueif it is valid,falseif not
-
getFromEntityReferenceOrNull
@Nullable public static EHTMLEntity getFromEntityReferenceOrNull(@Nullable String sEntityReference)
Get the predefined HTML entity for the specified entity reference string is valid.- Parameters:
sEntityReference- The string to be checked (e.g."–")- Returns:
nullif no such HTML entity is present
-
isValidEntityChar
public static boolean isValidEntityChar(char c)
Check if the passed character can be presented by an entity reference string.- Parameters:
c- The char to be checked (e.g.'–')- Returns:
trueif an entity representation is present,falseif not
-
getFromCharOrNull
@Nullable public static EHTMLEntity getFromCharOrNull(char c)
Get the predefined HTML entity to be used to represent the passed character.- Parameters:
c- The char to be checked (e.g.'–')- Returns:
nullif no such HTML entity is present
-
getEntityRefToEntityMap
@Nonnull @Nonempty @ReturnsMutableCopy public static final com.helger.commons.collection.impl.ICommonsOrderedMap<String,EHTMLEntity> getEntityRefToEntityMap()
- Returns:
- The global map from entity reference string to the according entity
(e.g. from
"–"toEHTMLEntity.ndash). Nevernullnor empty.
-
getCharToEntityMap
@Nonnull @Nonempty @ReturnsMutableCopy public static final com.helger.commons.collection.impl.ICommonsOrderedMap<Character,EHTMLEntity> getCharToEntityMap()
- Returns:
- The global map from entity reference string to the according entity
(e.g. from
'–'toEHTMLEntity.ndash). Nevernullnor empty.
-
getEntityRefToCharMap
@Nonnull @Nonempty @ReturnsMutableCopy public static final com.helger.commons.collection.impl.ICommonsOrderedMap<String,Character> getEntityRefToCharMap()
- Returns:
- The global map from entity reference string to the according
character (e.g. from
"–"to'–'). Nevernullnor empty.
-
getEntityRefToCharStringMap
@Nonnull @Nonempty @ReturnsMutableCopy public static final com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> getEntityRefToCharStringMap()
- Returns:
- The global map from entity reference string to the according
character as a String (e.g. from
"–"to"–"). Nevernullnor empty.
-
getCharToEntityRefMap
@Nonnull @Nonempty @ReturnsMutableCopy public static final com.helger.commons.collection.impl.ICommonsOrderedMap<Character,String> getCharToEntityRefMap()
- Returns:
- The global map from character to the according entity reference
string (e.g. from
'–'to"–"). Nevernullnor empty.
-
getCharStringToEntityRefMap
@Nonnull @Nonempty @ReturnsMutableCopy public static final com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> getCharStringToEntityRefMap()
- Returns:
- The global map from character string to the according entity
reference string (e.g. from
"–"to"–"). Nevernullnor empty.
-
-