oracle.mail.sdk.rule
Class RuleElement

oracle.mail.sdk.rule.RuleElement

Direct Known Subclasses:

Account, AccountType, ActionType, AttributeType, CommandType, ConditionType, InSectionType, OperatorType, RuleListType, RuleType

public abstract class RuleElement

Common super class for all rule objects. This class provides common utilities and maintains a parent-child relationship between elements. This class is not instantiable.

Since:

9.0

Method Summary

static java.lang.String	escapeString(java.lang.String str) escapes special characters in a string
RuleElement	getParent() Gets the parent element for the current element
java.lang.Object	getType() Gets the type object for the element.
void	printAttributes(oracle.xml.parser.v2.XMLOutputStream out, java.lang.String name) Serializes attributes into XML format
void	removeAll() Removes all child elements.
void	removeAt(int index) Removes an child element at a specific position starting with 0.

Method Detail

getType

public java.lang.Object getType()

Gets the type object for the element. This is used to get the AccountType object from an Account object.

Returns:

the type object

removeAt

public void removeAt(int index)

Removes an child element at a specific position starting with 0. E.g. this can be used to remove a specific RuleType object from a RuleListType object.

Parameters:

index - the index of the element

removeAll

public void removeAll()

Removes all child elements. E.g. this can be used to clear a list of ActionType objects from a RuleType object.

getParent

public RuleElement getParent()

Gets the parent element for the current element

Returns:

the parent element

escapeString

public static java.lang.String escapeString(java.lang.String str)

escapes special characters in a string

Parameters:

str - the input string to be escaped

Returns:

the resultant escaped string

printAttributes

public void printAttributes(oracle.xml.parser.v2.XMLOutputStream out,
                            java.lang.String name)
                     throws java.io.IOException

Serializes attributes into XML format

Parameters:

out - the output stream to write to

name - the attribute name