org.arl.fjage.shell

Class Documentation

java.lang.Object

org.arl.fjage.shell.Documentation

public class Documentation
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	cache
protected static java.lang.String	crlf
protected java.util.List<java.lang.String>	doc
protected static java.lang.String	gaps
protected static java.lang.String	header
protected static java.util.regex.Pattern	heading
protected static java.lang.String	placeholder
protected static java.util.regex.Pattern	section
protected int	staticSize

Constructor Summary

Constructors

Constructor and Description
Documentation()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String s) Add markdown documentation.
protected void	build(Agent agent) Build dynamic documentation by querying agents.
protected void	extract(java.lang.StringBuilder sb, int pos) Extract documentation.
java.lang.String	get(Agent agent) Get documentation index.
java.lang.String	get(Agent agent, java.lang.String keyword) Get documentation by keyword.
protected boolean	hasSubsections(int pos, int level) Check if a heading has sub-headings nested under it.
protected void	search(java.lang.StringBuilder sb, java.lang.String keyword) Search documentation topics by keyword.

Methods inherited from class java.lang.Object

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

Field Detail

doc

protected java.util.List<java.lang.String> doc

cache

protected java.util.Map<java.lang.String,java.lang.String> cache

staticSize

protected int staticSize

heading

protected static final java.util.regex.Pattern heading

section

protected static final java.util.regex.Pattern section

crlf

protected static final java.lang.String crlf

See Also:

Constant Field Values

header

protected static final java.lang.String header

See Also:

Constant Field Values

gaps

protected static final java.lang.String gaps

See Also:

Constant Field Values

placeholder

protected static final java.lang.String placeholder

See Also:

Constant Field Values

Constructor Detail

Documentation

public Documentation()

Method Detail

add

public void add(java.lang.String s)

Add markdown documentation.

Parameters:

s - multiline string.

get

public java.lang.String get(Agent agent)

Get documentation index.

get

public java.lang.String get(Agent agent,
                            java.lang.String keyword)

Get documentation by keyword.

Parameters:

keyword - keyword.

search

protected void search(java.lang.StringBuilder sb,
                      java.lang.String keyword)

Search documentation topics by keyword.

Parameters:

sb - string builder.

keyword - keyword.

extract

protected void extract(java.lang.StringBuilder sb,
                       int pos)

Extract documentation.

Parameters:

sb - string builder.

pos - position.

hasSubsections

protected boolean hasSubsections(int pos,
                                 int level)

Check if a heading has sub-headings nested under it.

Parameters:

pos - position of the heading.

level - level of the heading.

build

protected void build(Agent agent)

Build dynamic documentation by querying agents. Documentation may be cached for efficiency. If an agent wishes to avoid caching, it should return a documentation string that starts with "[no-cache]".

Agents with names with special characters (e.g. hyphen) are not queried for documentation. This is to cater for gateway agents that do not support any requests. Such agents should always use special characters in their advertised names.

Parameters:

agent - agent.