de.uka.ilkd.key.macros.scripts.meta

Class DescriptionFacade

java.lang.Object

de.uka.ilkd.key.macros.scripts.meta.DescriptionFacade

public final class DescriptionFacade
extends java.lang.Object

This facade is used to load documentation for ProofScriptCommand and ProofScriptArgument.

It uses a COMMANDS_DESCRIPTION property file.

Version:

1 (18.08.17)

Author:

Alexander Weigl

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	COMMANDS_DESCRIPTION The filename of the XML properties containing the documentation of proof script commands.
private static java.util.Properties	properties Lazy-loaded properties

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DescriptionFacade()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDocumentation(ProofScriptArgument<?> arg) Looks up the documentation for the given proof script argument.
static java.lang.String	getDocumentation(ProofScriptCommand<?> cmd) Looks up the documentation for the given command in the properties file.
static java.util.Properties	getProperties() Lazy loading of the properties.
private static java.lang.String	getString(java.lang.String key) Helper function for look ups in the property file.

Methods inherited from class java.lang.Object

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

Field Detail

COMMANDS_DESCRIPTION

private static final java.lang.String COMMANDS_DESCRIPTION

The filename of the XML properties containing the documentation of proof script commands.

See Also:

Constant Field Values

properties

private static java.util.Properties properties

Lazy-loaded properties

See Also:

getProperties()

Constructor Detail

DescriptionFacade

private DescriptionFacade()

Method Detail

getProperties

public static java.util.Properties getProperties()

Lazy loading of the properties.

Returns:

a properties

getDocumentation

public static java.lang.String getDocumentation(ProofScriptCommand<?> cmd)

Looks up the documentation for the given command in the properties file. If no documentation is available an empty string is returned.

Parameters:

cmd - non-null proof script command

Returns:

a non-null string

See Also:

ProofScriptCommand.getDocumentation()

getDocumentation

public static java.lang.String getDocumentation(ProofScriptArgument<?> arg)

Looks up the documentation for the given proof script argument. If no documentation is available an empty string is returned.

Parameters:

arg - non-null proof script argument

Returns:

a string or null, if arg is null or arg.getCommand returns null

See Also:

ProofScriptArgument.getDocumentation()

getString

private static java.lang.String getString(java.lang.String key)

Helper function for look ups in the property file.

Parameters:

key - look up key

Returns:

a non-null string