de.uka.ilkd.key.strategy.definition

Class AbstractStrategyPropertyDefinition

java.lang.Object

de.uka.ilkd.key.strategy.definition.AbstractStrategyPropertyDefinition

Direct Known Subclasses:

OneOfStrategyPropertyDefinition

public abstract class AbstractStrategyPropertyDefinition
extends java.lang.Object

Provides the basic function definition of user interface controls to edit a single key-value-pair in StrategyProperties.

Author:

Martin Hentschel

See Also:

OneOfStrategyPropertyDefinition

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	apiKey The key used in KeY's API.
private java.lang.String	name The human readable name of the property.
private ImmutableArray<AbstractStrategyPropertyDefinition>	subProperties Optional children which edits related properties to this.
private java.lang.String	tooltip The optional tooltip text which describes this property.

Constructor Summary

Constructors

Constructor and Description
AbstractStrategyPropertyDefinition(java.lang.String apiKey, java.lang.String name, java.lang.String tooltip, AbstractStrategyPropertyDefinition... subProperties) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiKey() Returns the key used in KeY's API.
java.lang.String	getName() Returns the human readable name of the property.
ImmutableArray<AbstractStrategyPropertyDefinition>	getSubProperties() Returns children which edits related properties to this.
java.lang.String	getTooltip() Returns the optional tooltip text which describes this property.

Methods inherited from class java.lang.Object

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

Field Detail

apiKey

private final java.lang.String apiKey

The key used in KeY's API.

name

private final java.lang.String name

The human readable name of the property.

tooltip

private final java.lang.String tooltip

The optional tooltip text which describes this property.

subProperties

private final ImmutableArray<AbstractStrategyPropertyDefinition> subProperties

Optional children which edits related properties to this. They might be shown different in the user interface.

Constructor Detail

AbstractStrategyPropertyDefinition

public AbstractStrategyPropertyDefinition(java.lang.String apiKey,
                                          java.lang.String name,
                                          java.lang.String tooltip,
                                          AbstractStrategyPropertyDefinition... subProperties)

Constructor.

Parameters:

apiKey - The key used in KeY's API.

name - The human readable name of the property.

tooltip - The optional tooltip text which describes this property.

subProperties - Optional children which edits related properties to this.

Method Detail

getApiKey

public java.lang.String getApiKey()

Returns the key used in KeY's API.

Returns:

The key used in KeY's API.

getName

public java.lang.String getName()

Returns the human readable name of the property.

Returns:

The human readable name of the property.

getTooltip

public java.lang.String getTooltip()

Returns the optional tooltip text which describes this property.

Returns:

The optional tooltip text which describes this property.

getSubProperties

public ImmutableArray<AbstractStrategyPropertyDefinition> getSubProperties()

Returns children which edits related properties to this. They might be shown different in the user interface.

Returns:

The children if available or an empty ImmutableArray otherwise.