Package de.espirit.firstspirit.generate

Interface UrlCreatorSpecification

public interface UrlCreatorSpecification
Specification container for url creator.
Since:
5.0.17

  • Method Details

    • 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:

    • 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

    • createUrlFactory

      @Nullable @Nullable UrlFactory createUrlFactory()
      In case the specification provides a valid UrlFactory class name for the property "urlfactory" this will deliver a new instance of the specified class. In all other cases this will deliver null. Please note that the "Advanced URLs" specification is the only FirstSpirit standard specification where a value != null is returned here.
      Returns:
      A new UrlCreator instance or null.
      Since:
      5.2.190300

    • 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 @Nullable String getLegacyClassName()
      Legacy class name (for backward compatibility only).
      Returns:
      Legacy class name (may be null).
      Since:
      5.0.17
      See Also:

    • isVisible

      boolean isVisible()
      Visibility flag from the module.xml file.
      Returns:
      Visbility (default is true).
      Since:
      5.0.17
      See Also: