Package net.officefloor.frame.api.source

Interface SourceProperties

All Known Subinterfaces:
AdministrationSourceContext, ExecutiveContext, ExecutiveSourceContext, GovernanceSourceContext, HttpSecuritySourceContext, ManagedFunctionSourceContext, ManagedObjectPoolSourceContext, ManagedObjectSourceContext<F>, OfficeExtensionContext, OfficeFloorExtensionContext, OfficeFloorSourceContext, OfficeSourceContext, SectionSourceContext, ServiceContext, SourceContext, SupplierSourceContext, TeamSourceContext, WebTemplateExtensionContext, WoofTemplateExtensionChangeContext, WoofTemplateExtensionConfiguration, WoofTemplateExtensionSourceContext
All Known Implementing Classes:
ConfigurationSourceContextImpl, ExecutiveContextImpl, ExecutiveSourceContextImpl, ManagedFunctionSourceContextImpl, ManagedObjectPoolSourceContextImpl, ManagedObjectSourceContextImpl, OfficeFloorSourceContextImpl, OfficeSourceContextImpl, PropertyListSourceProperties, SectionSourceContextImpl, SourceContextImpl, SourcePropertiesImpl, SupplierSourceContextImpl, TeamSourceContextWrapper
public interface SourceProperties
Properties for the source.
Author:
Daniel Sagenschneider

  • Method Details

    • getPropertyNames

      String[] getPropertyNames()

      Obtains the names of the available properties in the order they were defined. This allows for ability to provide variable number of properties identified by a naming convention and being able to maintain their order.

      An example would be providing a listing of routing configurations, each entry named route.[something] and order indicating priority.

      Returns:
      Names of the properties in the order defined.

    • getProperty

      String getProperty(String name) throws UnknownPropertyError
      Obtains a required property value.
      Parameters:
      name - Name of the property.
      Returns:
      Value of the property.
      Throws:
      UnknownPropertyError - If property was not configured. Let this propagate as OfficeFloor will handle it.

    • getProperty

      String getProperty(String name, String defaultValue)
      Obtains the property value or subsequently the default value.
      Parameters:
      name - Name of the property.
      defaultValue - Default value if property not specified.
      Returns:
      Value of the property or the the default value if not specified.

    • getProperties

      Properties getProperties()
      Properties to configure the source.
      Returns:
      Properties specific for the source.