PreParseAbandonOperation.java revision 407bb81fb935e713a4a1ae1b9189b81488a944d5
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
*/
/**
* This class defines a set of methods that are available for use by
* pre-parse plugins for abandon operations. Note that this interface
* is intended only to define an API for use by plugins and is not
* intended to be implemented by any custom classes.
*/
mayInstantiate=false,
mayExtend=false,
mayInvoke=true)
public interface PreParseAbandonOperation
extends PreParseOperation
{
/**
* Retrieves the message ID of the operation that should be
* abandoned.
*
* @return The message ID of the operation that should be
* abandoned.
*/
public int getIDToAbandon();
}