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 is the container for a regular file object. A regular
023: * file object contains just a filename.
024: *
025: * @author Jens-S. Vöckler
026: * @author Yong Zhao
027: * @version $Revision: 50 $
028: */
029: public class Regular extends File implements HasFilename {
030: /**
031: * Name of the file.
032: */
033: protected String m_filename;
034:
035: /**
036: * Default c'tor: Construct a hollow shell and allow further
037: * information to be added later.
038: */
039: public Regular() {
040: super ();
041: m_filename = null;
042: }
043:
044: /**
045: * Constructs a regular file.
046: * @param filename is the name of the file that stat was invoked
047: */
048: public Regular(String filename) {
049: super ();
050: m_filename = filename;
051: }
052:
053: /**
054: * Accessor
055: *
056: * @see #setFilename(String)
057: */
058: public String getFilename() {
059: return this .m_filename;
060: }
061:
062: /**
063: * Accessor.
064: *
065: * @param filename
066: * @see #getFilename()
067: */
068: public void setFilename(String filename) {
069: this .m_filename = filename;
070: }
071:
072: /**
073: * Dump the state of the current element as XML output. This function
074: * traverses all sibling classes as necessary, and converts the data
075: * into pretty-printed XML output. The stream interface should be able
076: * to handle large output efficiently.
077: *
078: * @param stream is a stream opened and ready for writing. This can also
079: * be a string stream for efficient output.
080: * @param indent is a <code>String</code> of spaces used for pretty
081: * printing. The initial amount of spaces should be an empty string.
082: * The parameter is used internally for the recursive traversal.
083: * If a <code>null</code> value is specified, no indentation nor
084: * linefeeds will be generated.
085: * @param namespace is the XML schema namespace prefix. If neither
086: * empty nor null, each element will be prefixed with this prefix,
087: * and the root element will map the XML namespace.
088: * @exception IOException if something fishy happens to the stream.
089: */
090: public void toXML(Writer stream, String indent, String namespace)
091: throws IOException {
092: String tag = (namespace != null && namespace.length() > 0) ? namespace
093: + ":file"
094: : "file";
095:
096: if (indent != null && indent.length() > 0)
097: stream.write(indent);
098: stream.write('<');
099: stream.write(tag);
100: writeAttribute(stream, " name=\"", m_filename);
101:
102: if (m_hexbyte != null && m_hexbyte.length() > 0) {
103: // yes, content
104: stream.write('>');
105: stream.write(m_hexbyte);
106: stream.write("</");
107: stream.write(tag);
108: stream.write('>');
109: } else {
110: // no content
111: stream.write("/>");
112: }
113:
114: if (indent != null)
115: stream.write(System.getProperty("line.separator", "\r\n"));
116: }
117: }
|