Package cdc.issues

Interface Param

All Superinterfaces:
Comparable<Param>, NameValue
All Known Implementing Classes:
ParamImpl
public interface Param extends NameValue, Comparable<Param>
Definition of an effective parameter.

It is a (name, value) pair, where name can not be null.

Author:
Damien Carbonne

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    Param.Builder
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use of(String, String).

  • Method Summary

    Modifier and Type
    Method
    Description
    static Param.Builder
    builder()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use of(String, String).
    static boolean
    isValidName(String name)
    Returns true if a string is a valid name: It cannot be null It cannot be empty It cannot contain any space or control character
    static Param
    of(String name, String value)
     

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface cdc.issues.NameValue

    getName, getValue

  • Method Details

    • of

      static Param of(String name, String value)
      Parameters:
      name - The name.
      value - The value.
      Returns:
      A new Param instance from name and value.
      Throws:
      IllegalArgumentException - When name is not valid.

    • isValidName

      static boolean isValidName(String name)
      Returns true if a string is a valid name:
      • It cannot be null
      • It cannot be empty
      • It cannot contain any space or control character
      Parameters:
      name - The name.
      Returns:
      true if label is a valid label.

    • builder

      @Deprecated(since="2014-03-30", forRemoval=true) static Param.Builder builder()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use of(String, String).
      Returns:
      A new Param.Builder of Param.