org.apache.maven.doxia.macro.snippet

Class SnippetReader

public class SnippetReader extends Object

Utility class for reading snippets.
Constructor Summary
SnippetReader(URL src)
Constructor.
Method Summary
protected booleanisDemarcator(String snippetId, String what, String line)
Determines if the given line is a demarcator.
protected booleanisEnd(String snippetId, String line)
Determines if the given line is an end demarcator.
protected booleanisStart(String snippetId, String line)
Determines if the given line is a start demarcator.
StringBufferreadSnippet(String snippetId)
Reads the snippet with given id.

Constructor Detail

SnippetReader

public SnippetReader(URL src)
Constructor.

Parameters: src The source.

Method Detail

isDemarcator

protected boolean isDemarcator(String snippetId, String what, String line)
Determines if the given line is a demarcator.

Parameters: snippetId the id of the snippet. what Identifier for the demarcator. line the line.

Returns: True, if the line is a start demarcator.

isEnd

protected boolean isEnd(String snippetId, String line)
Determines if the given line is an end demarcator.

Parameters: snippetId the id of the snippet. line the line.

Returns: True, if the line is an end demarcator.

isStart

protected boolean isStart(String snippetId, String line)
Determines if the given line is a start demarcator.

Parameters: snippetId the id of the snippet. line the line.

Returns: True, if the line is a start demarcator.

readSnippet

public StringBuffer readSnippet(String snippetId)
Reads the snippet with given id.

Parameters: snippetId The id of the snippet.

Returns: The snippet.

Throws: IOException if something goes wrong.

Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.