org.apache.sling.scripting.core

Class ScriptNameAwareReader

java.lang.Object

java.io.Reader

java.io.FilterReader

org.apache.sling.scripting.core.ScriptNameAwareReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable, ScriptNameAware

public final class ScriptNameAwareReader
extends FilterReader
implements ScriptNameAware

The ScriptNameAwareReader is a FilterReader marked with the ScriptNameAware interface. This reader allows retrieving the contained script's name.

Field Summary

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
ScriptNameAwareReader(Reader in, String scriptName) Creates a ScriptNameAwareReader based on another Reader.

Method Summary

Modifier and Type	Method and Description
String	getScriptName() Returns the name of the script provided by a marked Reader implementation.

Methods inherited from class java.io.FilterReader

close, mark, markSupported, read, read, ready, reset, skip

Methods inherited from class java.io.Reader

read, read

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptNameAwareReader

public ScriptNameAwareReader(Reader in,
                             String scriptName)

Creates a ScriptNameAwareReader based on another Reader.

Parameters:

in - the base Reader

scriptName - the script's name

Method Detail

getScriptName

public String getScriptName()

Description copied from interface: ScriptNameAware

Returns the name of the script provided by a marked Reader implementation.

Specified by:

getScriptName in interface ScriptNameAware

Returns:

the script's name