001/*
002 * Copyright (c) 2005-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-05-06 05:21:26 +0000 (Thu, 06 May 2010) $' 
007 * '$Revision: 24234 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.kepler.moml;
031
032import java.io.IOException;
033import java.io.Writer;
034
035import ptolemy.kernel.util.Attribute;
036import ptolemy.kernel.util.IllegalActionException;
037import ptolemy.kernel.util.InternalErrorException;
038import ptolemy.kernel.util.NameDuplicationException;
039import ptolemy.kernel.util.NamedObj;
040import ptolemy.kernel.util.Workspace;
041
042/**
043 * Deprecated. Please use the ptolemy.vergil.basic.KeplerDocumentationAttribute
044 * (found in the ptII CVS repository) instead. The exportMoML() method of this
045 * class will write out an empty string no matter what is in this attribute.
046 * 
047 *@author berkley
048 *@deprecated Use ptolemy.vergil.basic.KeplerDocumentationAttribute instead.
049 *@created March 1, 2005
050 */
051public class DocumentationAttribute extends Attribute {
052        /** Constructor */
053        public DocumentationAttribute() {
054                super();
055        }
056
057        /**
058         * Constructor
059         * 
060         *@param container
061         *            Description of the Parameter
062         *@param name
063         *            Description of the Parameter
064         *@exception IllegalActionException
065         *                Description of the Exception
066         *@exception NameDuplicationException
067         *                Description of the Exception
068         */
069        public DocumentationAttribute(NamedObj container, String name)
070                        throws IllegalActionException, NameDuplicationException {
071                super(container, name);
072        }
073
074        /**
075         * Constructor
076         * 
077         *@param workspace
078         *            Description of the Parameter
079         */
080        public DocumentationAttribute(Workspace workspace) {
081                super(workspace);
082        }
083
084        /**
085   *
086   */
087        public void updateContent() throws InternalErrorException {
088                // do nothing
089        }
090
091        public void exportMoML(Writer output, int depth, String name)
092                        throws IOException {
093                // Since this is deprecated, just write out nothing.
094                output.write("");
095        }
096}