RResult (Cthul XML 1.2 API)

java.lang.Object
- org.cthul.resolve.RResult

All Implemented Interfaces:

RResponse

Direct Known Subclasses:

BytesResult, FileResult, InputStreamResult, StringResult, URLResult
```
public abstract class RResult
extends Object
implements RResponse
```
Result of resource resolution.
Should be sub-classed to implement createReader(), getString(), or getEncoding() and one of createInputStream(), createByteBuffer(), createURLConnection(), or getResourceURL().
The base class contains many convenience methods to convert between all supported data formats (String, Reader, InputStream, ByteBuffer, URL). The conversion between character data and binary data is done with the Charset returned by getCharset(), which by default returns the Charset specified by getEncoding(). If the correct encoding was not set by the resource look-up, it should be set before converting data. Otherwise, the results depend on the default locale.

See Also:

BytesResult, FileResult, InputStreamResult, StringResult, URLResult

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`RResult.ByteBufferInputStream`
`protected static class`	`RResult.InputStreamURLConnection`
`static class`	`RResult.ResultType` Describes the format of the result data.

Constructor Summary

Constructors
Constructor and Description
`RResult(RRequest request)`
`RResult(RRequest request, String systemId)`
`RResult(String uri, String publicId, String systemId, String baseUri)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`BufferedInputStream`	`asBufferedInputStream()` Like `asInputStream()`, but always returns a buffered stream.
`ByteBuffer`	`asByteBuffer()` Returns the resource as a byte buffer, converting it if necessary.
`ResolvingException`	`asException()` Represents the warnings as single exception.
`InputStream`	`asInputStream()` Returns the resource as an input stream, converting it if necessary.
`Reader`	`asReader()` Returns the resource as a reader, converting it if necessary.
`String`	`asString()` Returns the resource as a string, converting it if necessary.
`URLConnection`	`asURLConnection()` Returns the resource as URL connection, converting it if necessary.
`protected ByteBuffer`	`bufferFrom(InputStream is)`
`protected ByteBuffer`	`bufferFrom(String s)`
`protected byte[]`	`bytesFrom(String s)`
`protected ByteBuffer`	`createByteBuffer()` Optional: creates a byte buffer to access the resource.
`protected InputStream`	`createInputStream()` Optional: creates an input stream to access the resource.
`protected Reader`	`createReader()` Optional: creates a reader to access the resource.
`protected URLConnection`	`createURLConnection()` Optional: creates a URL connection to access the resource.
`protected String`	`expandSystemId(String baseId, String systemId)` Calculates the resource location.
`protected InputStream`	`fromStreamOrBuffer()`
`protected InputStream`	`fromStreamOrBufferOrUrl()`
`protected InputStream`	`fromStreamOrUrl()`
`protected String`	`fromStringOrReader()`
`String`	`getBaseUri()` Returns the base URI of the request
`ByteBuffer`	`getByteBuffer()` Returns the resource as byte buffer, or `null`
`Charset`	`getCharset()` Returns the charset for the result's encoding, or the default charset of this JVM.
`protected Map<String,String>`	`getDefaultUrlConnectionHeader()`
`String`	`getEncoding()` Returns the resource's encoding.
`InputStream`	`getInputStream()` Returns the resource as input stream, or `null`
`String`	`getPublicId()` Returns the request public ID
`Reader`	`getReader()` Returns the resource as a reader, or `null`.
`RRequest`	`getRequest()` Returns the request for this result.
`String`	`getResolvedSystemId()` Creates a URI from the base URI and the system ID.
`URL`	`getResourceURL()` Returns the resource as URL, or `null`
`protected URL`	`getResourceURLOrSystemId()` Return the resource URL, or the system ID as URL.
`RResult`	`getResult()` Returns result if present, otherwise throws `RResponse.asException()`.
`abstract RResult.ResultType`	`getResultType()` Indicates the native format of this result.
`String`	`getString()` Returns the resource as string, or `null`
`String`	`getSystemId()` Returns the system ID of the resolved resource.
`String`	`getUri()` Returns the request URI
`String`	`getUriOrId()` Returns uri or resolved system id.
`URLConnection`	`getURLConnection()` Returns the resource as URL connection, or `null`
`List<Exception>`	`getWarningsLog()` Returns a list of non-critical exceptions that occurred during look-up.
`boolean`	`hasResult()` Returns true if look-up found a result.
`protected Reader`	`readerFrom(InputStream is)`
`protected String`	`resolveSystemId()`
`protected RuntimeException`	`resolvingException(Throwable t)`
`protected RuntimeException`	`resourceUnaccessible()`
`void`	`setDefaultEncoding(String enc)` Sets the default encoding, which is used when no other encoding is defined.
`void`	`setEncoding(String enc)` Sets the result's encoding.
`protected InputStream`	`streamFrom(ByteBuffer bb)`
`protected InputStream`	`streamFrom(String s)`
`protected InputStream`	`streamFrom(URLConnection uc)`
`protected InputStream`	`streamFromURLConnection()`
`protected String`	`stringFrom(ByteBuffer bb)`
`protected String`	`stringFrom(Reader r)`
`String`	`toString()`
`boolean`	`trySetEncoding(String enc)` Tries to set the result's encoding, returns true iff it was successful.

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

- Constructor Detail
  - RResult
```
public RResult(RRequest request)
```
  - RResult
```
public RResult(RRequest request,
               String systemId)
```
  - RResult
```
public RResult(String uri,
               String publicId,
               String systemId,
               String baseUri)
```
- Method Detail
  - hasResult
```
public boolean hasResult()
```
    Description copied from interface: RResponse
    
    Returns true if look-up found a result.
    
    Specified by:
    
    hasResult in interface RResponse
    
    Returns:
    
    true if result is present
  - getResult
```
public RResult getResult()
```
    Description copied from interface: RResponse
    
    Returns result if present, otherwise throws RResponse.asException().
    
    Specified by:
    
    getResult in interface RResponse
    
    Returns:
    
    result
  - getWarningsLog
```
public List<Exception> getWarningsLog()
```
    Description copied from interface: RResponse
    
    Returns a list of non-critical exceptions that occurred during look-up.
    
    Specified by:
    
    getWarningsLog in interface RResponse
    
    Returns:
    
    list of exceptions.
  - asException
```
public ResolvingException asException()
```
    Description copied from interface: RResponse
    
    Represents the warnings as single exception. Returns null if result is present and no warnings occurred.
    
    Specified by:
    
    asException in interface RResponse
    
    Returns:
    
    resolving exception
  - getRequest
```
public RRequest getRequest()
```
    Returns the request for this result.
    
    Specified by:
    
    getRequest in interface RResponse
    
    Returns:
    
    request
  - getUri
```
public String getUri()
```
    Returns the request URI
    
    Returns:
    
    request URI
  - getPublicId
```
public String getPublicId()
```
    Returns the request public ID
    
    Returns:
    
    public ID
  - getSystemId
```
public String getSystemId()
```
    Returns the system ID of the resolved resource.
    
    Returns:
    
    system ID
    
    See Also:
    
    getResolvedSystemId()
  - getBaseUri
```
public String getBaseUri()
```
    Returns the base URI of the request
    
    Returns:
    
    base URI
  - getUriOrId
```
public String getUriOrId()
```
    Returns uri or resolved system id.
    
    Returns:
    
    uri or system id
  - getResolvedSystemId
```
public String getResolvedSystemId()
```
    Creates a URI from the base URI and the system ID.
    
    Returns:
    
    uri
  - resolveSystemId
```
protected String resolveSystemId()
```
  - expandSystemId
```
protected String expandSystemId(String baseId,
                                String systemId)
```
    Calculates the resource location.
    
    Parameters:
    
    baseId -
    
    systemId -
    
    Returns:
    
    schema file path
  - getResultType
```
public abstract RResult.ResultType getResultType()
```
    Indicates the native format of this result.
    
    Returns:
    
    result type
  - getReader
```
public Reader getReader()
```
    Returns the resource as a reader, or null.
    
    Returns:
    
    reader
    
    See Also:
    
    asReader()
  - createReader
```
protected Reader createReader()
                       throws Exception
```
    Optional: creates a reader to access the resource.
    
    Returns:
    
    reader
    
    Throws:
    
    Exception
  - getInputStream
```
public InputStream getInputStream()
```
    Returns the resource as input stream, or null
    
    Returns:
    
    input stream
    
    See Also:
    
    asInputStream()
  - createInputStream
```
protected InputStream createInputStream()
                                 throws Exception
```
    Optional: creates an input stream to access the resource.
    
    Returns:
    
    input stream
    
    Throws:
    
    Exception
  - getString
```
public String getString()
```
    Returns the resource as string, or null
    
    Returns:
    
    string
  - getByteBuffer
```
public ByteBuffer getByteBuffer()
```
    Returns the resource as byte buffer, or null
    
    Returns:
    
    string
  - createByteBuffer
```
protected ByteBuffer createByteBuffer()
                               throws Exception
```
    Optional: creates a byte buffer to access the resource.
    
    Returns:
    
    byte buffer
    
    Throws:
    
    Exception
  - getURLConnection
```
public URLConnection getURLConnection()
```
    Returns the resource as URL connection, or null
    
    Returns:
    
    URL connection
  - createURLConnection
```
protected URLConnection createURLConnection()
                                     throws Exception
```
    Optional: creates a URL connection to access the resource. By default, tries to connect to the resource URL.
    
    Returns:
    
    URL connection
    
    Throws:
    
    Exception
  - getResourceURL
```
public URL getResourceURL()
                   throws Exception
```
    Returns the resource as URL, or null
    
    Returns:
    
    URL
    
    Throws:
    
    Exception
  - getResourceURLOrSystemId
```
protected URL getResourceURLOrSystemId()
                                throws Exception
```
    Return the resource URL, or the system ID as URL.
    
    Returns:
    
    url
    
    Throws:
    
    Exception
  - setDefaultEncoding
```
public void setDefaultEncoding(String enc)
```
    Sets the default encoding, which is used when no other encoding is defined.
    
    Parameters:
    
    enc -
  - trySetEncoding
```
public boolean trySetEncoding(String enc)
```
    Tries to set the result's encoding, returns true iff it was successful.
    
    Parameters:
    
    enc -
    
    Returns:
    
    true iff successful
  - setEncoding
```
public void setEncoding(String enc)
```
    Sets the result's encoding. Throws an exception if encoding could not be changed.
    
    Parameters:
    
    enc -
    
    Throws:
    
    IllegalStateException - if encoding could not be changed.
  - getEncoding
```
public String getEncoding()
```
    Returns the resource's encoding.
    
    Returns:
    
    encoding
  - getCharset
```
public Charset getCharset()
```
    Returns the charset for the result's encoding, or the default charset of this JVM.
    
    Returns:
    
    charset
  - asReader
```
public Reader asReader()
```
    Returns the resource as a reader, converting it if necessary.
    See the docs of RResult for notes on data conversion.
    
    Returns:
    
    reader
  - asInputStream
```
public InputStream asInputStream()
```
    Returns the resource as an input stream, converting it if necessary.
    See the docs of RResult for notes on data conversion.
    
    Returns:
    
    input stream
  - asByteBuffer
```
public ByteBuffer asByteBuffer()
```
    Returns the resource as a byte buffer, converting it if necessary.
    See the docs of RResult for notes on data conversion.
    
    Returns:
    
    byte buffer
  - asString
```
public String asString()
```
    Returns the resource as a string, converting it if necessary.
    See the docs of RResult for notes on data conversion.
    
    Returns:
    
    string
  - asURLConnection
```
public URLConnection asURLConnection()
```
    Returns the resource as URL connection, converting it if necessary.
    See the docs of RResult for notes on data conversion.
    
    Returns:
    
    URL connection
  - getDefaultUrlConnectionHeader
```
protected Map<String,String> getDefaultUrlConnectionHeader()
```
  - asBufferedInputStream
```
public BufferedInputStream asBufferedInputStream()
```
    Like asInputStream(), but always returns a buffered stream.
    
    Returns:
    
    buffered input stream
  - fromStringOrReader
```
protected String fromStringOrReader()
```
  - fromStreamOrBuffer
```
protected InputStream fromStreamOrBuffer()
```
  - fromStreamOrBufferOrUrl
```
protected InputStream fromStreamOrBufferOrUrl()
```
  - fromStreamOrUrl
```
protected InputStream fromStreamOrUrl()
```
  - stringFrom
```
protected String stringFrom(Reader r)
```
  - stringFrom
```
protected String stringFrom(ByteBuffer bb)
```
  - readerFrom
```
protected Reader readerFrom(InputStream is)
                     throws ResolvingException
```
    Throws:
    
    ResolvingException
  - streamFrom
```
protected InputStream streamFrom(String s)
                          throws ResolvingException
```
    Throws:
    
    ResolvingException
  - streamFrom
```
protected InputStream streamFrom(ByteBuffer bb)
```
  - streamFromURLConnection
```
protected InputStream streamFromURLConnection()
```
  - streamFrom
```
protected InputStream streamFrom(URLConnection uc)
```
  - bufferFrom
```
protected ByteBuffer bufferFrom(String s)
                         throws ResolvingException
```
    Throws:
    
    ResolvingException
  - bufferFrom
```
protected ByteBuffer bufferFrom(InputStream is)
```
  - bytesFrom
```
protected byte[] bytesFrom(String s)
                    throws ResolvingException
```
    Throws:
    
    ResolvingException
  - resolvingException
```
protected RuntimeException resolvingException(Throwable t)
```
  - resourceUnaccessible
```
protected RuntimeException resourceUnaccessible()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RResult

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RResult

RResult

RResult

Method Detail

hasResult

getResult

getWarningsLog

asException

getRequest

getUri

getPublicId

getSystemId

getBaseUri

getUriOrId

getResolvedSystemId

resolveSystemId

expandSystemId

getResultType

getReader

createReader

getInputStream

createInputStream

getString

getByteBuffer

createByteBuffer

getURLConnection

createURLConnection

getResourceURL

getResourceURLOrSystemId

setDefaultEncoding

trySetEncoding

setEncoding

getEncoding

getCharset

asReader

asInputStream

asByteBuffer

asString

asURLConnection

getDefaultUrlConnectionHeader

asBufferedInputStream

fromStringOrReader

fromStreamOrBuffer

fromStreamOrBufferOrUrl

fromStreamOrUrl

stringFrom

stringFrom

readerFrom

streamFrom

streamFrom

streamFromURLConnection

streamFrom

bufferFrom

bufferFrom

bytesFrom

resolvingException

resourceUnaccessible

toString