org.eclipse.emf.ecore.resource.impl

Class ContentHandlerImpl

java.lang.Object

org.eclipse.emf.ecore.resource.impl.ContentHandlerImpl

All Implemented Interfaces:

ContentHandler

Direct Known Subclasses:

PlatformContentHandlerImpl, XMLContentHandlerImpl

public class ContentHandlerImpl
extends java.lang.Object
implements ContentHandler

An implementation of a content handler.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContentHandlerImpl.Describer An implementation of a describer that delegates to a ContentHandler.

Nested classes/interfaces inherited from interface org.eclipse.emf.ecore.resource.ContentHandler

ContentHandler.ByteOrderMark, ContentHandler.Registry, ContentHandler.Validity

Field Summary

Fields inherited from interface org.eclipse.emf.ecore.resource.ContentHandler

BYTE_ORDER_MARK_PROPERTY, CHARSET_PROPERTY, CONTENT_TYPE_PROPERTY, INVALID_CONTENT_DESCRIPTION, LINE_DELIMITER_PROPERTY, OPTION_REQUESTED_PROPERTIES, UNSPECIFIED_CONTENT_TYPE, VALIDITY_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ContentHandlerImpl() Creates an instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHandle(URI uri) This implementations always return true; clients are generally expected to override this.
java.util.Map<java.lang.String,java.lang.Object>	contentDescription(URI uri, java.io.InputStream inputStream, java.util.Map<?,?> options, java.util.Map<java.lang.Object,java.lang.Object> context) This base implementation handles computing the ContentHandler.BYTE_ORDER_MARK_PROPERTY, the character set property, and the line delimiter property.
static java.util.Map<java.lang.String,java.lang.Object>	createContentDescription(ContentHandler.Validity validity) Creates a map with a single entry from ContentHandler.VALIDITY_PROPERTY to the given validity value.
protected ContentHandler.ByteOrderMark	getByteOrderMark(URI uri, java.io.InputStream inputStream, java.util.Map<?,?> options, java.util.Map<java.lang.Object,java.lang.Object> context) Returns the byte order marker at the start of the input stream.
protected java.lang.String	getCharset(URI uri, java.io.InputStream inputStream, java.util.Map<?,?> options, java.util.Map<java.lang.Object,java.lang.Object> context) Returns the character set of the input stream; this implementation simply returns null.
static java.lang.String	getLineDelimiter(java.io.InputStream inputStream, java.lang.String charset) Returns the line delimiter of the input stream interpreted using the specified character set.
protected java.lang.String	getLineDelimiter(URI uri, java.io.InputStream inputStream, java.util.Map<?,?> options, java.util.Map<java.lang.Object,java.lang.Object> context) Returns the line delimiter of the input stream; it's computed from the bytes interpreted using the appropriate character set.
protected java.util.Set<java.lang.String>	getRequestedProperties(java.util.Map<?,?> options) Returns the value of ContentHandler.OPTION_REQUESTED_PROPERTIES in the options map.
protected boolean	isRequestedProperty(java.lang.String property, java.util.Map<?,?> options) Returns whether the named property is one requested in the options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContentHandlerImpl

public ContentHandlerImpl()

Creates an instance.

Method Detail

createContentDescription

public static java.util.Map<java.lang.String,java.lang.Object> createContentDescription(ContentHandler.Validity validity)

Creates a map with a single entry from ContentHandler.VALIDITY_PROPERTY to the given validity value.

Parameters:

validity - the value of the validity property.

Returns:

a map with a single entry from ContentHandler.VALIDITY_PROPERTY to the given validity value.

getRequestedProperties

protected java.util.Set<java.lang.String> getRequestedProperties(java.util.Map<?,?> options)

Returns the value of ContentHandler.OPTION_REQUESTED_PROPERTIES in the options map.

Parameters:

options - the options in which to look up the property.

Returns:

value of ContentHandler.OPTION_REQUESTED_PROPERTIES in the options map.

isRequestedProperty

protected boolean isRequestedProperty(java.lang.String property,
                          java.util.Map<?,?> options)

Returns whether the named property is one requested in the options.

Parameters:

property - the property in question.

options - the options in which to look for the requested property.

Returns:

whether the named property is one requested in the options.

See Also:

getRequestedProperties(Map)

canHandle

public boolean canHandle(URI uri)

This implementations always return true; clients are generally expected to override this.

Specified by:

canHandle in interface ContentHandler

Parameters:

uri - the URI in questions.

Returns:

true;

contentDescription

public java.util.Map<java.lang.String,java.lang.Object> contentDescription(URI uri,
                                                                  java.io.InputStream inputStream,
                                                                  java.util.Map<?,?> options,
                                                                  java.util.Map<java.lang.Object,java.lang.Object> context)
                                                                    throws java.io.IOException

This base implementation handles computing the ContentHandler.BYTE_ORDER_MARK_PROPERTY, the character set property, and the line delimiter property. for each such requested property.

Specified by:

contentDescription in interface ContentHandler

Parameters:

uri - the URI for which to determine the content description.

inputStream - the input stream associated with the given URI.

options - a map of options to direct what kind of description is needed.

context - a map of contextual information that content handlers use to store partially computed results.

Returns:

a map of properties that describe the content of the given URI's corresponding input stream.

Throws:

java.io.IOException - if there is a problem reading the stream.

getCharset

protected java.lang.String getCharset(URI uri,
                          java.io.InputStream inputStream,
                          java.util.Map<?,?> options,
                          java.util.Map<java.lang.Object,java.lang.Object> context)
                               throws java.io.IOException

Returns the character set of the input stream; this implementation simply returns null.

Parameters:

uri - the URI of the input stream.

inputStream - the input stream.

options - any options that might influence the interpretation of the content.

context - a cache for previously computed information.

Returns:

the character set of the input stream.

Throws:

java.io.IOException - if there is a problem loading the content.

Since:

2.9

getLineDelimiter

protected java.lang.String getLineDelimiter(URI uri,
                                java.io.InputStream inputStream,
                                java.util.Map<?,?> options,
                                java.util.Map<java.lang.Object,java.lang.Object> context)
                                     throws java.io.IOException

Returns the line delimiter of the input stream; it's computed from the bytes interpreted using the appropriate character set.

Parameters:

uri - the URI of the input stream.

inputStream - the input stream.

options - any options that might influence the interpretation of the content.

context - a cache for previously computed information.

Returns:

the line delimiter of the input stream.

Throws:

java.io.IOException - if there is a problem loading the content.

Since:

2.9

getLineDelimiter

public static java.lang.String getLineDelimiter(java.io.InputStream inputStream,
                                java.lang.String charset)
                                         throws java.io.IOException

Returns the line delimiter of the input stream interpreted using the specified character set. It is the caller's responsibility to close the input stream.

Throws:

java.io.IOException

Since:

2.9

getByteOrderMark

protected ContentHandler.ByteOrderMark getByteOrderMark(URI uri,
                                            java.io.InputStream inputStream,
                                            java.util.Map<?,?> options,
                                            java.util.Map<java.lang.Object,java.lang.Object> context)
                                                 throws java.io.IOException

Returns the byte order marker at the start of the input stream.

Parameters:

uri - the URI of the input stream.

inputStream - the input stream to scan.

options - any options to influence the behavior; this base implementation ignores this.

context - the cache for fetching and storing a previous computation of the byte order marker; this base implementation caches ContentHandler.BYTE_ORDER_MARK_PROPERTY.

Returns:

the byte order marker at the start of the input stream.

Throws:

java.io.IOException