/*
* Copyright (c) 2001-2013 Oracle and/or its affiliates. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of Oracle nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.sun.msv.reader;
import com.sun.msv.grammar.Expression;
/**
* Base implementation for those states who read tags representing an expression.
*
* <p>
* Responsibility of derived classes are:
*
* <ol>
* <li>if necessary, implement startSelf method to do something.
* <li>implement createChildState method, which is mandated by SimpleState.
* <li>implement makeExpression method to create Expression object
* as the outcome of parsing. This method is called at endElement.
* </ol>
*
* @author <a href="mailto:kohsuke.kawaguchi@eng.sun.com">Kohsuke KAWAGUCHI</a>
*/
public abstract class ExpressionState extends SimpleState
{
protected void endSelf()
{
// creates a expression, then calls a hook of reader,
Expression exp = reader.interceptExpression( this, makeExpression() );
if( parentState!=null )
// then finally pass it to the parent
((ExpressionOwner)parentState).onEndChild(exp);
// interceptExpression is a hook by reader.
// it is used to implement handling of occurs attribute in RELAX.
// application-defined reader can also do something useful for them here.
super.endSelf();
}
/**
* This method is called from endElement method.
* Implementation has to provide Expression object that represents the content of
* this element.
*/
protected abstract Expression makeExpression();
}