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-2006 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.apache.tools.ant.module.spi;
043:
044: import java.util.Set;
045: import org.apache.tools.ant.module.run.LoggerTrampoline;
046:
047: /**
048: * Describes the structure of a task.
049: * Each instance corresponds to one task or nested element in a build script.
050: * @author Jesse Glick
051: * @since org.apache.tools.ant.module/3 3.12
052: */
053: public final class TaskStructure {
054:
055: static {
056: LoggerTrampoline.TASK_STRUCTURE_CREATOR = new LoggerTrampoline.Creator() {
057: public AntSession makeAntSession(
058: LoggerTrampoline.AntSessionImpl impl) {
059: throw new AssertionError();
060: }
061:
062: public AntEvent makeAntEvent(
063: LoggerTrampoline.AntEventImpl impl) {
064: throw new AssertionError();
065: }
066:
067: public TaskStructure makeTaskStructure(
068: LoggerTrampoline.TaskStructureImpl impl) {
069: return new TaskStructure(impl);
070: }
071: };
072: }
073:
074: private final LoggerTrampoline.TaskStructureImpl impl;
075:
076: private TaskStructure(LoggerTrampoline.TaskStructureImpl impl) {
077: this .impl = impl;
078: }
079:
080: /**
081: * Get the element name.
082: * XXX precise behavior w.r.t. namespaces etc.
083: * @return a name, never null
084: */
085: public String getName() {
086: return impl.getName();
087: }
088:
089: /**
090: * Get a single attribute.
091: * It will be unevaluated as configured in the script.
092: * If you wish to find the actual runtime value, you may
093: * use {@link AntEvent#evaluate}.
094: * @param name the attribute name
095: * @return the raw value of that attribute, or null
096: */
097: public String getAttribute(String name) {
098: return impl.getAttribute(name);
099: }
100:
101: /**
102: * Get a set of all defined attribute names.
103: * @return a set of names suitable for {@link #getAttribute}; may be empty but not null
104: */
105: public Set<String> getAttributeNames() {
106: return impl.getAttributeNames();
107: }
108:
109: /**
110: * Get configured nested text.
111: * It will be unevaluated as configured in the script.
112: * If you wish to find the actual runtime value, you may
113: * use {@link AntEvent#evaluate}.
114: * @return the raw text contained in the element, or null
115: */
116: public String getText() {
117: return impl.getText();
118: }
119:
120: /**
121: * Get any configured child elements.
122: * @return a list of child structure elements; may be empty but not null
123: */
124: public TaskStructure[] getChildren() {
125: return impl.getChildren();
126: }
127:
128: @Override
129: public String toString() {
130: return impl.toString();
131: }
132:
133: }
|