Skip to content

Package io.github.qishr.cascara.common.lang.processor

Interface Emitter

java.lang.Object
        io.github.qishr.cascara.common.lang.processor.Emitter

All Implemented Interfaces:
    Processor

All Known Implementing Classes:
    JsonEmitter, YamlEmitter


public interface Emitter

A generic interface for emitting structured text.

Method Summary

Modifier and Type Method Description
public abstract void emitScalar(String value) Writes a literal scalar value.
public abstract void emitMapStart() Signals the start of a mapping/object.
public abstract void emitMapEnd() Signals the end of a mapping/object.
public abstract void emitSequenceStart() Signals the start of a sequence/list.
public abstract void emitSequenceEnd() Signals the end of a sequence/list.
public abstract void emitPropertySeparator() Writes a separator between key and value.
public abstract void emitItemSeparator() Writes a separator between items in a collection.
public abstract void emitNewLine() Manages white-space and indentation.
public abstract void indent()
public abstract void dedent()
public abstract String getOutput() Returns the final produced string.
public abstract ContentType getContentType()

Method Details

emitScalar

public abstract void emitScalar(String value)

Writes a literal scalar value.


emitMapStart

public abstract void emitMapStart()

Signals the start of a mapping/object.


emitMapEnd

public abstract void emitMapEnd()

Signals the end of a mapping/object.


emitSequenceStart

public abstract void emitSequenceStart()

Signals the start of a sequence/list.


emitSequenceEnd

public abstract void emitSequenceEnd()

Signals the end of a sequence/list.


emitPropertySeparator

public abstract void emitPropertySeparator()

Writes a separator between key and value.


emitItemSeparator

public abstract void emitItemSeparator()

Writes a separator between items in a collection.


emitNewLine

public abstract void emitNewLine()

Manages white-space and indentation.


indent

public abstract void indent()


dedent

public abstract void dedent()


getOutput

public abstract String getOutput()

Returns the final produced string.


getContentType

public abstract ContentType getContentType()

Specified By:

Processor