org.w3c.css.sac: public class: InputSource

org.w3c.css.sac
public class: InputSource [javadoc | source]

java.lang.Object
   org.w3c.css.sac.InputSource

A single input source for a CSS source.

This class allows a CSS application to encapsulate information about an input source in a single object, which may include a URI, a byte stream (possibly with a specified encoding), and/or a character stream.

The CSS parser will use the InputSource object to determine how to read CSS input. If there is a character stream available, the parser will read that stream directly; if not, the parser will use a byte stream, if available; if neither a character stream nor a byte stream is available, the parser will attempt to open a URI connection to the resource identified by the URI.

An InputSource object belongs to the application: the CSS parser shall never modify it in any way (it may modify a copy if necessary).

version: $ - Revision: 477010 $

author: Philippe - Le Hegaret

Constructor:

Constructor:
public InputSource() { } Zero-argument default constructor. Also see: setURI setByteStream setCharacterStream setEncoding
public InputSource(String uri) { setURI(uri); } Create a new input source with a URI. The URI must be full resolved. Parameters: `uri` - The URI. Also see: setURI setByteStream setEncoding setCharacterStream
public InputSource(Reader characterStream) { setCharacterStream(characterStream); } Create a new input source with a character stream. Application writers may use setURI() to provide a base for resolving relative URIs, and setPublicId to include a public identifier. The character stream shall not include a byte order mark. Also see: setURI setByteStream setCharacterStream

 public InputSource() {

}

Zero-argument default constructor.

Also see:

 public InputSource(String uri) {
	setURI(uri);
}

The URI must be full resolved.

Parameters:

uri - The URI.

Also see:

 public InputSource(Reader characterStream) {
	setCharacterStream(characterStream);
}

Application writers may use setURI() to provide a base for resolving relative URIs, and setPublicId to include a public identifier.

The character stream shall not include a byte order mark.

Also see:

setURI

setByteStream

setCharacterStream

Method from org.w3c.css.sac.InputSource Summary:
getByteStream, getCharacterStream, getEncoding, getMedia, getTitle, getURI, setByteStream, setCharacterStream, setEncoding, setMedia, setTitle, setURI

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

Method from org.w3c.css.sac.InputSource Detail:
public InputStream getByteStream() { return byteStream; } Get the byte stream for this input source. The getEncoding method will return the character encoding for this byte stream, or null if unknown.
public Reader getCharacterStream() { return characterStream; } Get the character stream for this input source.
public String getEncoding() { return encoding; } Get the character encoding for a byte stream or URI.
public String getMedia() { if (media == null) { return "all"; } return media; } Returns the media associated to the input source or `null` if media are currently unknown.
public String getTitle() { return title; } Returns the title for this input source.
public String getURI() { return uri; } Get the URI for this input source. The getEncoding method will return the character encoding of the object pointed to, or null if unknown. The URI will be fully resolved.
public void setByteStream(InputStream byteStream) { this.byteStream = byteStream; } Set the byte stream for this input source. The SAX parser will ignore this if there is also a character stream specified, but it will use a byte stream in preference to opening a URI connection itself. If the application knows the character encoding of the byte stream, it should set it with the setEncoding method.
public void setCharacterStream(Reader characterStream) { this.characterStream = characterStream; } Set the character stream for this input source. If there is a character stream specified, the SAX parser will ignore any byte stream and will not attempt to open a URI connection to the URI.
public void setEncoding(String encoding) { this.encoding = encoding; } Set the character encoding, if known. The encoding must be a string acceptable for an CHARSET encoding declaration (see section 4.4 of the CSS recommendation Level 2). This method has no effect when the application provides a character stream.
public void setMedia(String media) { this.media = media; } Set the media for this input source.
public void setTitle(String title) { this.title = title; } Set the title for this input source.
public void setURI(String uri) { this.uri = uri; } Set the URI for this input source. The URI is optional if there is a byte stream or a character stream, but it is still useful to provide one, since the application can use it to resolve relative URIs and can include it in error messages and warnings (the parser will attempt to open a connection to the URI only if there is no byte stream or character stream specified). If the application knows the character encoding of the object pointed to by the URI, it can register the encoding using the setEncoding method. The URI must be fully resolved.

Method from org.w3c.css.sac.InputSource Detail:

 public InputStream getByteStream() {
	return byteStream;
}

The getEncoding method will return the character encoding for this byte stream, or null if unknown.

 public Reader getCharacterStream() {
	return characterStream;
}

Get the character stream for this input source.

 public String getEncoding() {
	return encoding;
}

Get the character encoding for a byte stream or URI.

 public String getMedia() {
	if (media == null) {
	    return "all";
	}
	return media;
}

null

 public String getTitle() {
	return title;
}

Returns the title for this input source.

 public String getURI() {
	return uri;
}

The getEncoding method will return the character encoding of the object pointed to, or null if unknown.

The URI will be fully resolved.

 public  void setByteStream(InputStream byteStream) {
	this.byteStream = byteStream;
}

The SAX parser will ignore this if there is also a character stream specified, but it will use a byte stream in preference to opening a URI connection itself.

If the application knows the character encoding of the byte stream, it should set it with the setEncoding method.

 public  void setCharacterStream(Reader characterStream) {
	this.characterStream = characterStream;
}

If there is a character stream specified, the SAX parser will ignore any byte stream and will not attempt to open a URI connection to the URI.

 public  void setEncoding(String encoding) {
	this.encoding = encoding;
}

The encoding must be a string acceptable for an CHARSET encoding declaration (see section 4.4 of the CSS recommendation Level 2).

This method has no effect when the application provides a character stream.

 public  void setMedia(String media) {
	this.media = media;
}

Set the media for this input source.

 public  void setTitle(String title) {
	this.title = title;
}

Set the title for this input source.

 public  void setURI(String uri) {
	this.uri = uri;
}

The URI is optional if there is a byte stream or a character stream, but it is still useful to provide one, since the application can use it to resolve relative URIs and can include it in error messages and warnings (the parser will attempt to open a connection to the URI only if there is no byte stream or character stream specified).

If the application knows the character encoding of the object pointed to by the URI, it can register the encoding using the setEncoding method.

The URI must be fully resolved.