ScriptReader.DefaultIncluder

java.lang.Object

com.blackrook.rookscript.compiler.ScriptReader.DefaultIncluder

All Implemented Interfaces:: ScriptReaderIncluder, PreprocessorLexer.Includer

Enclosing class:: ScriptReader

public static class ScriptReader.DefaultIncluder extends Object implements ScriptReaderIncluder

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.

Method Summary

Modifier and Type

Method

Description

InputStream

getIncludeResource(String path)

Returns an open InputStream for a path when the parser needs a resource.

String

getIncludeResourcePath(String streamName, 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.blackrook.rookscript.struct.PreprocessorLexer.Includer
getEncodingForIncludedResource

Method Details
- getIncludeResourcePath
  
  public String getIncludeResourcePath(String streamName, String path) throws IOException
  
  Description copied from interface: PreprocessorLexer.Includer
  
  Returns a full path for a path when the parser needs a resource.
  
  Specified by:
  
  getIncludeResourcePath in interface 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:
  
  IOException - if an error occurs procuring a potential stream.
- getIncludeResource
  
  public InputStream getIncludeResource(String path) throws IOException
  
  Description copied from interface: 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 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:
  
  IOException - if an error occurs opening a stream.