001: /*
002: * This file or a portion of this file is licensed under the terms of
003: * the Globus Toolkit Public License, found in file GTPL, or at
004: * http://www.globus.org/toolkit/download/license.html. This notice must
005: * appear in redistributions of this file, with or without modification.
006: *
007: * Redistributions of this Software, with or without modification, must
008: * reproduce the GTPL in: (1) the Software, or (2) the Documentation or
009: * some other similar material which is provided with the Software (if
010: * any).
011: *
012: * Copyright 1999-2004 University of Chicago and The University of
013: * Southern California. All rights reserved.
014: */
015: package org.griphyn.vdl.invocation;
016:
017: import java.util.*;
018: import java.io.Writer;
019: import java.io.IOException;
020:
021: /**
022: * This class pushes an environmental entry into the environment map.
023: * This calls is expected to be transient to the parsing process only.
024: *
025: * @author Jens-S. Vöckler
026: * @author Yong Zhao
027: * @version $Revision: 50 $
028: */
029: public class EnvEntry extends Invocation implements HasText {
030: /**
031: * environment handle
032: */
033: private String m_key;
034:
035: /**
036: * environment value
037: */
038: private StringBuffer m_value;
039:
040: /**
041: * Default c'tor: Construct a hollow shell and allow further
042: * information to be added later.
043: */
044: public EnvEntry() {
045: m_key = null;
046: m_value = null;
047: }
048:
049: /**
050: * C'tor: Prepares a given key for accepting a value later on.
051: * @param key is the key to prepare
052: */
053: public EnvEntry(String key) {
054: m_key = key;
055: m_value = null;
056: }
057:
058: /**
059: * C'tor: Fully initializes the class
060: * @param key is the key to prepare
061: * @param value is the value to remember
062: */
063: public EnvEntry(String key, String value) {
064: m_key = key;
065: m_value = new StringBuffer(value);
066: }
067:
068: /**
069: * Appends a piece of text to the existing text.
070: * @param fragment is a piece of text to append to existing text.
071: * Appending <code>null</code> is a noop.
072: */
073: public void appendValue(String fragment) {
074: if (fragment != null) {
075: if (this .m_value == null)
076: this .m_value = new StringBuffer(fragment);
077: else
078: this .m_value.append(fragment);
079: }
080: }
081:
082: /**
083: * Accessor
084: *
085: * @see #setKey(String)
086: */
087: public String getKey() {
088: return this .m_key;
089: }
090:
091: /**
092: * Accessor.
093: *
094: * @param m_key
095: * @see #getKey()
096: */
097: public void setKey(String m_key) {
098: this .m_key = m_key;
099: }
100:
101: /**
102: * Accessor
103: *
104: * @see #setValue(String)
105: */
106: public String getValue() {
107: return (m_value == null ? null : m_value.toString());
108: }
109:
110: /**
111: * Accessor.
112: *
113: * @param value is the new value to set.
114: * @see #getValue()
115: */
116: public void setValue(String value) {
117: this .m_value = (value == null ? null : new StringBuffer(value));
118: }
119:
120: /**
121: * Converts the active state into something meant for human consumption.
122: * The method will be called when recursively traversing the instance
123: * tree.
124: *
125: * @param stream is a stream opened and ready for writing. This can also
126: * be a string stream for efficient output.
127: */
128: public void toString(Writer stream) throws IOException {
129: stream.write(m_key);
130: stream.write('=');
131: stream.write(getValue());
132: }
133:
134: /**
135: * Dumps the state of the current element as XML output. However, for
136: * the given instance, this class is ludicrious.
137: *
138: * @param stream is a stream opened and ready for writing. This can also
139: * be a string stream for efficient output.
140: * @param indent is a <code>String</code> of spaces used for pretty
141: * printing. The initial amount of spaces should be an empty string.
142: * The parameter is used internally for the recursive traversal.
143: * @param namespace is the XML schema namespace prefix. If neither
144: * empty nor null, each element will be prefixed with this prefix,
145: * and the root element will map the XML namespace.
146: * @exception IOException if something fishy happens to the stream.
147: */
148: public void toXML(Writer stream, String indent, String namespace)
149: throws IOException {
150: String tag = (namespace != null && namespace.length() > 0) ? namespace
151: + ":env"
152: : "env";
153:
154: // open tag
155: if (indent != null && indent.length() > 0)
156: stream.write(indent);
157: stream.write('<');
158: stream.write(tag);
159: writeAttribute(stream, " key=\"", quote(getKey(), true));
160: stream.write('>');
161:
162: stream.write(quote(getValue(), false));
163:
164: stream.write("</");
165: stream.write(tag);
166: stream.write('>');
167: if (indent != null)
168: stream.write(System.getProperty("line.separator", "\r\n"));
169: }
170:
171: }
|