XmlDeclStream (JHOVE - JSTOR/Harvard Object Validation Environment 1.16.0 API)

java.lang.Object
- java.io.InputStream
- - java.io.FilterInputStream
  - - edu.harvard.hul.ois.jhove.module.xml.XmlDeclStream

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class XmlDeclStream
extends FilterInputStream
```
This class is layered under the InputSource for the XmlModule so that it can detect an XML declaration and character references, which aren't reported by other API's. This is called XmlDeclStream for historical reasons, though it's no longer limited to that function.

Author:

Gary McGath

Field Summary

Fields
Modifier and Type Field and Description

protected boolean _lineEndCR

protected boolean _lineEndCRLF

protected boolean _lineEndLF

protected int _prevChar
- Fields inherited from class java.io.FilterInputStream
  in

Fields
Modifier and Type	Field and Description
`protected boolean`	`_lineEndCR`
`protected boolean`	`_lineEndCRLF`
`protected boolean`	`_lineEndLF`
`protected int`	`_prevChar`

Constructor Summary

Constructors
Constructor and Description

XmlDeclStream(InputStream strm)

Constructors
Constructor and Description
`XmlDeclStream(InputStream strm)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkLineEnd(int ch)`
`List<Integer>`	`getCharacterReferences()` Returns the character references as a List of Integers.
`String`	`getEncoding()` Returns the encoding string.
`String`	`getKindOfLineEnd()`
`String`	`getStandalone()` Returns the standalone string.
`String`	`getVersion()` Returns the version string.
`int`	`read()` Reads the next byte of data from this input stream.
`int`	`read(byte[] b)` Reads up to `byte.length` bytes of data from this input stream into an array of bytes.
`int`	`read(byte[] b, int off, int len)` Reads up to `len` bytes of data from this input stream into an array of bytes.

Methods inherited from class java.io.FilterInputStream
available, close, mark, markSupported, reset, skip

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _lineEndCR
```
protected boolean _lineEndCR
```
  - _lineEndLF
```
protected boolean _lineEndLF
```
  - _lineEndCRLF
```
protected boolean _lineEndCRLF
```
  - _prevChar
```
protected int _prevChar
```
- Constructor Detail
  - XmlDeclStream
```
public XmlDeclStream(InputStream strm)
```
- Method Detail
  - read
```
public int read()
         throws IOException
```
    Reads the next byte of data from this input stream. Processes bytes as it reads them.
    
    Overrides:
    
    read in class FilterInputStream
    
    Throws:
    
    IOException
  - read
```
public int read(byte[] b)
         throws IOException
```
    Reads up to byte.length bytes of data from this input stream into an array of bytes. Processes bytes as it reads them.
    
    Overrides:
    
    read in class FilterInputStream
    
    Throws:
    
    IOException
  - read
```
public int read(byte[] b,
                int off,
                int len)
         throws IOException
```
    Reads up to len bytes of data from this input stream into an array of bytes. Processes bytes as it reads them.
    
    Overrides:
    
    read in class FilterInputStream
    
    Throws:
    
    IOException
  - getCharacterReferences
```
public List<Integer> getCharacterReferences()
```
    Returns the character references as a List of Integers. No sorting or elimination of duplicates is done; this is just all the character references in the order they occurred.
  - getVersion
```
public String getVersion()
```
    Returns the version string. May be null (though it shouldn't be in well-formed XML).
  - getEncoding
```
public String getEncoding()
```
    Returns the encoding string. May be null.
  - getStandalone
```
public String getStandalone()
```
    Returns the standalone string. May be null.
  - checkLineEnd
```
protected void checkLineEnd(int ch)
```
  - getKindOfLineEnd
```
public String getKindOfLineEnd()
```

Class XmlDeclStream

Field Summary

Fields inherited from class java.io.FilterInputStream

Constructor Summary

Method Summary

Methods inherited from class java.io.FilterInputStream

Methods inherited from class java.lang.Object

Field Detail

_lineEndCR

_lineEndLF

_lineEndCRLF

_prevChar

Constructor Detail

XmlDeclStream

Method Detail

read

read

read

getCharacterReferences

getVersion

getEncoding

getStandalone

checkLineEnd

getKindOfLineEnd