org.ka2ddo.yaac.core

Class Macros.MacroInfo

java.lang.Object

org.ka2ddo.yaac.core.Macros.MacroInfo

Enclosing class:

Macros

public static class Macros.MacroInfo
extends java.lang.Object

The class containing all the data associated with a macro name.

Since:

PROVIDER_API_VERSION == 50

Author:

Andrew Pavlin, KA2DDO

Constructor Summary

Constructors

Constructor and Description
MacroInfo()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLocalizedDescription() Get the localized description of the purpose of this macro.
java.lang.String	getValue() Get the value of the macro.

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroInfo

public MacroInfo()

Method Detail

getValue

public java.lang.String getValue()

Get the value of the macro. May be null if not set yet.

Returns:

String value of the macro, or null for unset macros

getLocalizedDescription

public java.lang.String getLocalizedDescription()

Get the localized description of the purpose of this macro. May be set by plugins providing the macros.

Returns:

String description of the macro, or empty String if unknown/unset