de.espirit.firstspirit.generate

Interface UrlCreatorSpecification

public interface UrlCreatorSpecification

Specification container for url creator.

Since:

5.0.17

Method Summary

Methods

Modifier and Type	Method and Description
UrlCreator	createUrlCreator() Create a new UrlCreator instance with the specified settings from the module.xml.
UrlCreator	createUrlCreator(Map<String,String> settings) Create a new UrlCreator instance with custom settings.
String	getLegacyClassName() Legacy class name (for backward compatibility only).
String	getName() Name definition from the module.xml.
Map<String,String>	getSettings() Default settings, specified in the module.xml file.
boolean	isVisible() Visibility flag from the module.xml file.

Method Detail

getName

String getName()

Name definition from the module.xml.

Returns:

The name definition (extracted from the module.xml).

Since:

5.0.17

createUrlCreator

UrlCreator createUrlCreator()

Create a new UrlCreator instance with the specified settings from the module.xml.

Returns:

UrlCreator New instance.

Since:

5.0.17

See Also:

getSettings()

createUrlCreator

UrlCreator createUrlCreator(Map<String,String> settings)

Create a new UrlCreator instance with custom settings.

Parameters:

settings - custom settings (overriding the settings from the module.xml).

Returns:

UrlCreator New instance.

Since:

5.0.17

getSettings

Map<String,String> getSettings()

Default settings, specified in the module.xml file.

Returns:

The specified settings from the module.xml.

Since:

5.0.17

getLegacyClassName

@Nullable
String getLegacyClassName()

Legacy class name (for backward compatibility only).

Returns:

Legacy class name (may be null).

Since:

5.0.17

See Also:

getSettings()

isVisible

boolean isVisible()

Visibility flag from the module.xml file.

Returns:

Visbility (default is true).

Since:

5.0.17

See Also:

getSettings()