Package com.tameif.tame.factory

Class DefaultIncluder

java.lang.Object

com.tameif.tame.factory.DefaultIncluder

All Implemented Interfaces:

TAMEScriptIncluder, com.tameif.tame.struct.PreprocessorLexer.Includer

public class DefaultIncluder
extends java.lang.Object
implements TAMEScriptIncluder

Default includer to use when none specified. This includer can either pull from the classpath, URIs, or files.

• Paths that start with classpath: are parsed as resource paths in the current classpath.
• Else, the path is interpreted as a file path, with the following search order:
  • Relative to parent of source stream.
  • As is.

Constructor Summary

Constructors

Constructor and Description
DefaultIncluder()

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getIncludeResource(java.lang.String path) Returns an open InputStream for a path when the parser needs a resource.
java.lang.String	getIncludeResourcePath(java.lang.String streamName, java.lang.String path) Returns a full path for a path when the parser needs a resource.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tameif.tame.struct.PreprocessorLexer.Includer

getEncodingForIncludedResource

Constructor Detail

DefaultIncluder

public DefaultIncluder()

Method Detail

getIncludeResourcePath

public java.lang.String getIncludeResourcePath(java.lang.String streamName,
                                               java.lang.String path)
                                        throws java.io.IOException

Description copied from interface: com.tameif.tame.struct.PreprocessorLexer.Includer

Returns a full path for a path when the parser needs a resource.

Specified by:

getIncludeResourcePath in interface com.tameif.tame.struct.PreprocessorLexer.Includer

Parameters:

streamName - the current name of the stream. This includer may use this to procure a relative path.

path - the stream path from the include directive.

Returns:

the path to a possible resource, or null if no possible path is available.

Throws:

java.io.IOException - if an error occurs procuring a potential stream.

getIncludeResource

public java.io.InputStream getIncludeResource(java.lang.String path)
                                       throws java.io.IOException

Description copied from interface: com.tameif.tame.struct.PreprocessorLexer.Includer

Returns an open InputStream for a path when the parser needs a resource. By default, this attempts to open a file at the provided path.

Specified by:

getIncludeResource in interface com.tameif.tame.struct.PreprocessorLexer.Includer

Parameters:

path - the resolved stream path from the include directive.

Returns:

an open InputStream for the requested resource, or null if not found.

Throws:

java.io.IOException - if an error occurs opening a stream.