Package com.iizix.prop

Interface IPropCnrString

All Known Implementing Classes:
PlotString
public interface IPropCnrString
Interface for a generic string setting for a property container implemented by enum classes with validation support.
Author:
Christopher Mindus

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDefaultValue()
    Gets the default value when the property is not set.
    String
    getPropName()
    Returns the name of the property, usually starting with '$'.
    default void
    validate(PropCnr pc, String string)
    Validates a new string.

  • Method Details

    • getDefaultValue

      String getDefaultValue()
      Gets the default value when the property is not set.
      Returns:
      The default value, or null for none.

    • validate

      default void validate(PropCnr pc, String string) throws PropValidateException
      Validates a new string.

      Override to provide validation, default doesn't validate.

      Parameters:
      pc - The property container that will be set.
      string - The string to validate.
      Throws:
      NullPointerException - If the string is null.
      PropValidateException - If the string doesn't validate.

    • getPropName

      String getPropName()
      Returns the name of the property, usually starting with '$'.