|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.jsieve.util.SieveToXml
public class SieveToXml
Converts Sieve nodes to xml.
Settings default to draft-freed-sieve-in-xml-01
Sieve Email Filtering: Sieves and display directives in XML.
For simplicity, allow elements are out into a single namespace.
Nested Class Summary | |
---|---|
static interface |
SieveToXml.NameMapper
Maps node names to element names. |
static interface |
SieveToXml.Out
Simple infoset output. |
Field Summary | |
---|---|
static java.lang.String[] |
CONTROL_COMMANDS
Control commands (as listed in RFC 3028) |
static java.lang.String |
DEFAULT_NAME_ACTION_COMMAND
|
static java.lang.String |
DEFAULT_NAME_ATTRIBUTE
|
static java.lang.String |
DEFAULT_NAME_CONTROL_COMMAND
|
static java.lang.String |
DEFAULT_NAME_LIST
|
static java.lang.String |
DEFAULT_NAME_NUM
|
static java.lang.String |
DEFAULT_NAME_STRING
|
static java.lang.String |
DEFAULT_NAME_TAG
|
static java.lang.String |
DEFAULT_NAME_TEST
|
static java.lang.String |
DEFAULT_NAMESPACE
|
static java.lang.String |
DEFAULT_PREFIX
|
Constructor Summary | |
---|---|
SieveToXml()
|
Method Summary | |
---|---|
SieveHandler |
build(SieveToXml.Out out)
Builds a handler to writes to the given output. |
SieveToXml.NameMapper |
getCommandNameMapper()
Gets mapper for command names. |
java.lang.String |
getListElementName()
Gets the element name used for lists. |
java.lang.String |
getNameAttributeName()
Gets the name of the attribute to be used to name command and tests. |
java.lang.String |
getNamespacePrefix()
Gets the namespace prefix to be used for all elements and attributes. |
java.lang.String |
getNamespaceUri()
Gets the namespace URI to be used for all elements and attributes. |
java.lang.String |
getNumberElementName()
Gets the name of the element that wraps a numeric argument. |
java.lang.String |
getStringElementName()
Gets the name of the element that wraps a string element. |
java.lang.String |
getTagElementName()
Gets the name of the element that wraps a tag element. |
SieveToXml.NameMapper |
getTestNameMapper()
Gets the mapper for names of test nodes. |
void |
setCommandNameMapper(SieveToXml.NameMapper commandNameMapper)
Sets mapper for command names. |
void |
setListElementName(java.lang.String listElementName)
Sets the element name used for lists. |
void |
setNameAttributeName(java.lang.String nameAttributeName)
Sets the name of the attribute to be used to indicate command and test names. |
void |
setNamespacePrefix(java.lang.String namespacePrefix)
Sets the namespace prefix to be used for all elements and attributes. |
void |
setNamespaceUri(java.lang.String namespaceUri)
Sets the namespace uri to be used for all elements and attributes. |
void |
setNumberElementName(java.lang.String numberElementName)
Sets the name of the element that wraps a numeric argument. |
void |
setStringElementName(java.lang.String stringElementName)
Sets the name of the element that wraps a string element. |
void |
setTagElementName(java.lang.String tagElementName)
Sets the name of the element that wraps a tag element |
void |
setTestNameMapper(SieveToXml.NameMapper testNameMapper)
Sets the mapper for names of test nodes. |
static SieveToXml.NameMapper |
sieveInXmlMapper()
Creates a mapper which returns values given in draft-freed-sieve-in-xml-01
Sieve Email Filtering: Sieves and display directives in XML. |
static SieveToXml.NameMapper |
uniformMapper(java.lang.String elementLocalName)
Creates a mapper which will return the same name for any node. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_NAME_ATTRIBUTE
public static final java.lang.String DEFAULT_NAME_ACTION_COMMAND
public static final java.lang.String DEFAULT_NAME_CONTROL_COMMAND
public static final java.lang.String DEFAULT_NAME_TEST
public static final java.lang.String DEFAULT_NAME_LIST
public static final java.lang.String DEFAULT_NAME_NUM
public static final java.lang.String DEFAULT_NAME_TAG
public static final java.lang.String DEFAULT_NAME_STRING
public static final java.lang.String DEFAULT_PREFIX
public static final java.lang.String DEFAULT_NAMESPACE
public static final java.lang.String[] CONTROL_COMMANDS
Constructor Detail |
---|
public SieveToXml()
Method Detail |
---|
public static final SieveToXml.NameMapper uniformMapper(java.lang.String elementLocalName)
elementLocalName
- to be returned for all names, not null
public static final SieveToXml.NameMapper sieveInXmlMapper()
draft-freed-sieve-in-xml-01
Sieve Email Filtering: Sieves and display directives in XML.
public SieveToXml.NameMapper getCommandNameMapper()
public void setCommandNameMapper(SieveToXml.NameMapper commandNameMapper)
commandNameMapper
- public java.lang.String getListElementName()
public void setListElementName(java.lang.String listElementName)
listElementName
- not nullpublic java.lang.String getNameAttributeName()
public void setNameAttributeName(java.lang.String nameAttributeName)
nameAttributeName
- naming attribute,
or null when no attribute should be usedpublic java.lang.String getNamespacePrefix()
public void setNamespacePrefix(java.lang.String namespacePrefix)
namespacePrefix
- namespace, or null when no namespace should be usedpublic java.lang.String getNamespaceUri()
public void setNamespaceUri(java.lang.String namespaceUri)
namespaceUri
- namespace URI, or null when no namespace should be usedpublic java.lang.String getNumberElementName()
public void setNumberElementName(java.lang.String numberElementName)
numberElementName
- not nullpublic java.lang.String getStringElementName()
public void setStringElementName(java.lang.String stringElementName)
stringElementName
- not nullpublic java.lang.String getTagElementName()
public void setTagElementName(java.lang.String tagElementName)
tagElementName
- not nullpublic SieveToXml.NameMapper getTestNameMapper()
public void setTestNameMapper(SieveToXml.NameMapper testNameMapper)
testNameMapper
- not nullpublic SieveHandler build(SieveToXml.Out out)
out
- output, not null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |