Package org.apache.torque.generator.source.stream

# Klasse XmlSourceFormat

java.lang.Object
org.apache.torque.generator.source.stream.XmlSourceFormat

Alle implementierten Schnittstellen:
  `StreamSourceFormat`

public final class XmlSourceFormat extends Object implements StreamSourceFormat
The source type representing an XML source. $Id: XmlSourceFormat.java 1917241 2024-04-21 13:29:41Z tv $

- ## Konstruktorübersicht

  Konstruktoren
  Konstruktor
  Beschreibung
  `XmlSourceFormat()`

- ## Methodenübersicht

  Modifizierer und Typ
  Methode
  Beschreibung
  `boolean`
  `equals(Object other)`
  Checks whether other is equal to this instance.
  `String`
  `getFilenameExtension()`
  Gets the filename extension this source type typically has.
  `String`
  `getKey()`
  Returns an unique key for the source type.
  `int`
  `hashCode()`
  Returns a hash code of this instance consistent with equals..
  `SourceElement`
  `parse(InputStream xmlStream, ControllerState controllerState)`
  Parses a stream containing xml data and creates a source element hierarchy from it.
  `String`
  `toString()`

  ### Von Klasse geerbte Methoden java.lang.Object

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- ## Konstruktordetails

  - ### XmlSourceFormat

    public XmlSourceFormat()

- ## Methodendetails

  - ### getKey

    public String getKey()
    Returns an unique key for the source type.
    Angegeben von:
      `getKey` in Schnittstelle `StreamSourceFormat`
    Gibt zurück:
      "xml".

  - ### getFilenameExtension

    public String getFilenameExtension()
    Gets the filename extension this source type typically has.
    Angegeben von:
      `getFilenameExtension` in Schnittstelle `StreamSourceFormat`
    Gibt zurück:
      "xml".

  - ### parse

    public SourceElement parse(InputStream xmlStream, ControllerState controllerState) throws SourceException
    Parses a stream containing xml data and creates a source element hierarchy from it.
    Angegeben von:
      `parse` in Schnittstelle `StreamSourceFormat`
    Parameter:
      `xmlStream` - the stream containing the xml data, not null.
      `controllerState` - the controller state, not null.
    Gibt zurück:
      the root element of the created hierarchy.
    Löst aus:
      `SourceException` - if an error occurs reading the input stream, parsing the XML data or if the SAX parser is not configured correctly.

  - ### hashCode

    public int hashCode()
    Returns a hash code of this instance consistent with equals.. As all instances of this class are equal to each other, the hash code is always the same.
    Setzt außer Kraft:
      `hashCode` in Klasse `Object`
    Gibt zurück:
      1.

  - ### equals

    public boolean equals(Object other)
    Checks whether other is equal to this instance. All instances of this class are equal to each other.
    Setzt außer Kraft:
      `equals` in Klasse `Object`
    Gibt zurück:
      true if `other` is a XmlSourceType, false otherwise.

  - ### toString

    public String toString()
    Setzt außer Kraft:
      `toString` in Klasse `Object`