001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.uml.core.reverseengineering.reframework.parsingframework;
043:
044: import org.netbeans.modules.uml.core.reverseengineering.reframework.IREOperation;
045:
046: public interface ILanguageParser {
047: /**
048: * Process the given file. The fileName should be an absolute path to the file.
049: */
050: public void parseFile(String filename);
051:
052: /**
053: * Process the given file. The fileName should be an absolute path to the file.
054: */
055: public void parseFile(String filename, String charset);
056:
057: /**
058: * Parse the contents of the specified operation. Message events will be sent the registered reverse engineering listeners.
059: */
060: public void parseOperation(String filename, IREOperation operation);
061:
062: /**
063: * Parse the contents of the specified operation. Message events will be sent the registered reverse engineering listeners.
064: */
065: public void parseOperation(String filename, String charset,
066: IREOperation operation);
067:
068: /**
069: * Get/Sets the parsers state listener.
070: */
071: public IStateListener getStateListener();
072:
073: /**
074: * Get/Sets the parsers state listener.
075: */
076: public void setStateListener(IStateListener stateListener);
077:
078: /**
079: * Get/Sets the parsers state filter.
080: */
081: public IStateFilter getStateFilter();
082:
083: /**
084: * Get/Sets the parsers state filter.
085: */
086: public void setStateFilter(IStateFilter filter);
087:
088: /**
089: * Get/Sets the interface that will process tokens found while parsing a file.
090: */
091: public ITokenProcessor getTokenProcessor();
092:
093: /**
094: * Get/Sets the interface that will process tokens found while parsing a file.
095: */
096: public void setTokenProcessor(ITokenProcessor tokenProcessor);
097:
098: /**
099: * Get/Sets the interface that will process tokens found while parsing a file.
100: */
101: public ITokenFilter getTokenFilter();
102:
103: /**
104: * Get/Sets the interface that will process tokens found while parsing a file.
105: */
106: public void setTokenFilter(ITokenFilter filter);
107:
108: /**
109: * Get/Sets the interface that will process errors found while parsing a file.
110: */
111: public IErrorListener getErrorListener();
112:
113: /**
114: * Get/Sets the interface that will process errors found while parsing a file.
115: */
116: public void setErrorListener(IErrorListener errorListener);
117:
118: /**
119: * Process the given file. The fileName should be an absolute path to the file.
120: */
121: public void processStreamByType(String stream, /* ProcessTypeKind */
122: int kind);
123:
124: }
|