org.apache.neethi
Interface PolicyComponent

All Known Subinterfaces:

Assertion, PolicyOperator

All Known Implementing Classes:

AbstractPolicyOperator, PolicyReference, XmlPrimtiveAssertion

public interface PolicyComponent

This is an interface which any component of the framework must implement.

Method Summary

boolean	equal(PolicyComponent policyComponent) Returns true if the argument is equal to self.
short	getType() Returns a short value which uniquely identify the type of the PolicyComponent.
void	serialize(javax.xml.stream.XMLStreamWriter writer) Serializes the PolicyComponent using an XMLStreamWriter.

Method Detail

serialize

public void serialize(javax.xml.stream.XMLStreamWriter writer)
               throws javax.xml.stream.XMLStreamException

Serializes the PolicyComponent using an XMLStreamWriter.

Parameters:

writer - the writer that the component should write itself

Throws:

javax.xml.stream.XMLStreamException - if an errors in the process of serialization of the PolicyComponent.

getType

public short getType()

Returns a short value which uniquely identify the type of the PolicyComponent.

Returns:

Constants.POLICY for Policy type PolicyComponent Constants.EXACTLYONE for ExactlyOne type PolicyComponent Constants.ALL for All type PolicyComponent Constants.ASSERTION for Assertion type PolicyComponent

equal

public boolean equal(PolicyComponent policyComponent)

Returns true if the argument is equal to self.

Parameters:

policyComponent - the PolicyComponent to check whether self is logically equal or not

Returns:

ture if the argument is equal to self.