biz.hammurapi.web.mda
Interface Channel

All Superinterfaces:

biz.hammurapi.util.Attributable

All Known Subinterfaces:

RootChannel, SubChannel

All Known Implementing Classes:

AbstractChannel, FileRootChannel, MemorySubChannel

public interface Channel

extends biz.hammurapi.util.Attributable

Output channel for templates. Channels form a hierarchy. Each channel can have multiple sub-channels (parts). Part can be either writer or channel, whichever was retrieved first.

Author:

Pavel

Method Summary

SubChannel	getChannel(java.lang.String partName)
SubChannel	getChannel(java.lang.String[] path)
java.util.Map	getParts()
java.io.Writer	getWriter(java.lang.String partName)
java.io.Writer	getWriter(java.lang.String[] path)

Methods inherited from interface biz.hammurapi.util.Attributable

getAttribute, removeAttribute, setAttribute

Method Detail

getWriter

public java.io.Writer getWriter(java.lang.String partName)
                         throws java.lang.IllegalStateException

Returns:

Part writer to output generated code

Throws:

java.lang.IllegalStateException - If channel for this part has already been retrieved.

getWriter

public java.io.Writer getWriter(java.lang.String[] path)

Parameters:

path - Parts path.

Returns:

Writer by path

Throws:

java.lang.IllegalStateException - If channel for the last path elementhas already been retrieved or if writer has been retrieve for one of non-last elements.

getChannel

public SubChannel getChannel(java.lang.String partName)
                      throws java.lang.IllegalStateException

Returns:

Part sub-channel to output generated code

Throws:

java.lang.IllegalStateException - If writer for this part has already been retrieved.

getChannel

public SubChannel getChannel(java.lang.String[] path)

Parameters:

path - Parts path.

Returns:

Channel by path

Throws:

java.lang.IllegalStateException - If writer for one of path elements has already been retrieved.

getParts

public java.util.Map getParts()

Returns:

Map of parts.