com.hfg.xml.XMLDoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.xml;

import java.io.*;
import java.nio.charset.Charset;


//------------------------------------------------------------------------------
/**
 XMLDoc is a generic XML document container.

 @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------
// https://en.wikipedia.org/wiki/Root_element

public class XMLDoc extends XMLBasedDoc
{

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   public XMLDoc()
   {
      super();
   }

   //---------------------------------------------------------------------------
   public XMLDoc(XMLTag inRootNode)
   {
      super(inRootNode);
   }

   //---------------------------------------------------------------------------
   /**
    The preferred way to read XML from a file.
    @param inFile The XML file to read.
    */
   public XMLDoc(File inFile)
      throws XMLException, IOException
   {
      super(inFile);
   }

   //---------------------------------------------------------------------------
   public XMLDoc(BufferedReader inReader)
   {
      super(inReader);
   }

   //---------------------------------------------------------------------------
   /**
    The preferred way to read XML from a stream.
    */
   public XMLDoc(BufferedInputStream inStream)
   {
      super(inStream);
   }

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################


   //---------------------------------------------------------------------------
   @Override
   public XMLDoc setName(String inValue)
   {
      return (XMLDoc) super.setName(inValue);
   }


   //---------------------------------------------------------------------------
   @Override
   public XMLDoc clone()
   {
      return (XMLDoc) super.clone();
   }

   //---------------------------------------------------------------------------
   @Override
   public XMLDoc setSpec(XMLSpec inValue)
   {
      return (XMLDoc) super.setSpec(inValue);
   }

   //---------------------------------------------------------------------------
   @Override
   public XMLDoc setEncoding(Charset inValue)
   {
      return (XMLDoc) super.setEncoding(inValue);
   }

   //---------------------------------------------------------------------------
   @Override
   public XMLDoc setIsStandalone(boolean inValue)
   {
      return (XMLDoc) super.setIsStandalone(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public XMLDoc setDoctype(Doctype inValue)
   {
      return (XMLDoc) super.setDoctype(inValue);
   }
}