com.sun.jsftemplating.layout.template.CustomParserCommand Maven / Gradle / Ivy

Go to download
/*
 * The contents of this file are subject to the terms 
 * of the Common Development and Distribution License 
 * (the License).  You may not use this file except in
 * compliance with the License.
 * 
 * You can obtain a copy of the license at 
 * https://jsftemplating.dev.java.net/cddl1.html or
 * jsftemplating/cddl1.txt.
 * See the License for the specific language governing 
 * permissions and limitations under the License.
 * 
 * When distributing Covered Code, include this CDDL 
 * Header Notice in each file and include the License file 
 * at jsftemplating/cddl1.txt.  
 * If applicable, add the following below the CDDL Header, 
 * with the fields enclosed by brackets [] replaced by
 * you own identifying information: 
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
 */
package com.sun.jsftemplating.layout.template;

import java.io.IOException;


/**
 *  	This interface provides a way to process "custom" parser commands.
 *	These commands are in the format: "<![custom command name] ...".
 *	They must be registered with the TemplateParser to be recognized.
 *	See {@link TemplateReader#setCustomParserCommand(String, CustomParserCommand)}.
 *
 *  @author Ken Paulsen	([email protected])
 */
public interface CustomParserCommand {

    /**
     *	 This method processes a "custom" command.  These are commands that
     *	    start with a !.  When this method receives control, the
     *	    name (i.e. the token after the '!' character) has
     *	    already been read.  It is passed via the name
     *	    parameter.
     *
     *	 The {@link ProcessingContext} and
     *	    {@link ProcessingContextEnvironment} are both available.
     */
    void process(ProcessingContext ctx, ProcessingContextEnvironment env, String name) throws IOException;
}