1 /* 2 * Copyright 2001-2004 The Apache Software Foundation. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package org.apache.neethi; 17 18 import javax.xml.namespace.QName; 19 import javax.xml.stream.XMLStreamException; 20 import javax.xml.stream.XMLStreamWriter; 21 22 /** 23 * This is an interface that any Assertion must implement. Hence any domain 24 * specific type can be used with this framework if it implements this 25 * interface. 26 */ 27 public interface Assertion extends PolicyComponent { 28 29 /** 30 * Returns the QName of the Root Element of this Assertion. 31 * 32 * @return QName the QName of the Root Element of this Assertion. 33 */ 34 public QName getName(); 35 36 /** 37 * Returns true if this Assertion is optional. Returns false otherwise. 38 * 39 * @return true if the assertion is optional. 40 */ 41 public boolean isOptional(); 42 43 /** 44 * Serialize this Assertion into its XML infoset using XMLStreamWriter. 45 */ 46 public void serialize(XMLStreamWriter writer) throws XMLStreamException; 47 48 /** 49 * Returns a new PolicyComponent that is the normalized version of this. 50 */ 51 public PolicyComponent normalize(); 52 }