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.generativeframework;
043:
044: import org.dom4j.Node;
045:
046: import org.netbeans.modules.uml.core.support.umlutils.ETList;
047:
048: public interface IVariableFactory {
049: /**
050: * Creates a variable using the passed in node as the actual representation.
051: */
052: public IExpansionVariable createVariable(Node var);
053:
054: /**
055: * The context object passed through all expansions.
056: */
057: public IVariableExpander getExecutionContext();
058:
059: /**
060: * The context object passed through all expansions.
061: */
062: public void setExecutionContext(IVariableExpander value);
063:
064: /**
065: * The location of a configuration file that contains Expansion variable definitions
066: */
067: public String getConfigFile();
068:
069: /**
070: * The location of a configuration file that contains Expansion variable definitions
071: */
072: public void setConfigFile(String value);
073:
074: /**
075: * Creates an expansion variable with the text found in a template file.
076: */
077: public IExpansionVariable createVariableWithText(String varText);
078:
079: /**
080: * Removes an execution context from the internal stack of contexts.
081: */
082: public IVariableExpander getPopContext();
083:
084: /**
085: * The collection of variables used to provide new or override existing expansion variables.
086: */
087: public ETList<IExpansionVariable> getOverrideVariables();
088:
089: /**
090: * The collection of variables used to provide new or override existing expansion variables.
091: */
092: public void setOverrideVariables(ETList<IExpansionVariable> value);
093:
094: /**
095: * Adds a new or overriding expansion variable.
096: */
097: public void addOverride(IExpansionVariable var);
098:
099: /**
100: * Removes an expansion variable from the OverrideVariables collection.
101: */
102: public void removeOverride(IExpansionVariable var);
103:
104: }
|