Package org.soulwing.prospecto.runtime.text

Class AbstractViewReader

java.lang.Object

org.soulwing.prospecto.runtime.text.AbstractViewReader

All Implemented Interfaces:

ViewReader

Direct Known Subclasses:

JsonPViewReader

public abstract class AbstractViewReader
extends Object
implements ViewReader

An abstract base for ViewReader implementations.

Author:

Carl Harris

Nested Class Summary

Nested classes/interfaces inherited from interface org.soulwing.prospecto.api.ViewReader

ViewReader.Source

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractViewReader(Options options)	Constructs a new reader

Method Summary

Modifier and Type	Method	Description
protected void	beginArray(String name)	Adds a View.Event.Type.BEGIN_ARRAY event to the view.
protected void	beginArray(String name, String namespace)	Adds a View.Event.Type.BEGIN_ARRAY event to the view.
protected void	beginObject(String name)	Adds a View.Event.Type.BEGIN_OBJECT event to the view.
protected void	beginObject(String name, String namespace)	Adds a View.Event.Type.BEGIN_OBJECT event to the view.
protected void	discriminator(Object value)	Adds a subtype discriminator to the view.
protected void	end()	Adds a View.Event.Type.END_OBJECT or View.Event.Type.END_ARRAY event to the view, depending on what was the last beginType invocation.
Options	getOptions()
protected void	meta(String name, Object value)	Adds a metadata value to a view.
protected void	nullValue(String name)	Adds a null value to the view.
protected abstract void	onReadView()	Notifies the recipient that it should read the textual representation, invoking callbacks as necessary to create the event stream for the view.
View	readView()
protected void	value(String name, Boolean value)	Adds a boolean value to the view.
protected void	value(String name, Number value)	Adds a numeric value to the view.
protected void	value(String name, String value)	Adds a string value to the view.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractViewReader

protected AbstractViewReader(Options options)

Constructs a new reader

Parameters:

options - configuration options

Method Detail

getOptions

public Options getOptions()

readView

public View readView()
              throws ViewException

Specified by:

readView in interface ViewReader

Throws:

ViewException

onReadView

protected abstract void onReadView()
                            throws Exception

Notifies the recipient that it should read the textual representation, invoking callbacks as necessary to create the event stream for the view.

Throws:

Exception

beginObject

protected final void beginObject(String name)

Adds a View.Event.Type.BEGIN_OBJECT event to the view.

Parameters:

name - name of the object

beginObject

protected final void beginObject(String name,
                                 String namespace)

Adds a View.Event.Type.BEGIN_OBJECT event to the view.

Parameters:

name - name of the object

beginArray

protected final void beginArray(String name)

Adds a View.Event.Type.BEGIN_ARRAY event to the view.

Parameters:

name - name of the object

beginArray

protected final void beginArray(String name,
                                String namespace)

Adds a View.Event.Type.BEGIN_ARRAY event to the view.

Parameters:

name - name of the object

end

protected final void end()

Adds a View.Event.Type.END_OBJECT or View.Event.Type.END_ARRAY event to the view, depending on what was the last beginType invocation.

discriminator

protected final void discriminator(Object value)

Adds a subtype discriminator to the view.

Parameters:

value - discriminator value

meta

protected final void meta(String name,
                          Object value)

Adds a metadata value to a view.

Parameters:

name - metadata name

value - metadata value

value

protected final void value(String name,
                           String value)

Adds a string value to the view.

Parameters:

name - name of the value

value - string value (not null)

value

protected final void value(String name,
                           Number value)

Adds a numeric value to the view.

Parameters:

name - name of the value

value - numeric value (not null)

value

protected final void value(String name,
                           Boolean value)

Adds a boolean value to the view.

Parameters:

name - name of the value

value - boolean value (not null)

nullValue

protected final void nullValue(String name)

Adds a null value to the view.

Parameters:

name - name of the value