Package org.immutables.encode

Enum Encoding.StandardNaming

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Encoding.StandardNaming>
    Enclosing class:
    Encoding
    public static enum Encoding.StandardNaming
extends java.lang.Enum<Encoding.StandardNaming>
    Standard namings can be used to reuse standard styles, like the ones defined in Value.Immutable.Style for the custom-defined elements in encoding. If Encoding.StandardNaming is used with the generator other than Immutables which do not have notion of namings/styles, then, typical default values will be used.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADD
      builder add method, depluralized.
      ADD_ALL
      builder add all method.
      GET
      naming of the accessor method.
      INIT
      builder init method.
      NONE
      no standard naming is used.
      PUT
      builder put method, depluralized.
      PUT_ALL
      builder put all method.
      WITH
      with copy method.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      boolean depluralize  
      java.lang.String pattern  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private StandardNaming​(java.lang.String pattern)  
      private StandardNaming​(java.lang.String pattern, boolean depluralize)  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Encoding.StandardNaming valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Encoding.StandardNaming[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • pattern

        public final java.lang.String pattern

      • depluralize

        public final boolean depluralize

    • Constructor Detail

      • StandardNaming

        private StandardNaming​(java.lang.String pattern)

      • StandardNaming

        private StandardNaming​(java.lang.String pattern,
                       boolean depluralize)

    • Method Detail

      • values

        public static Encoding.StandardNaming[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Encoding.StandardNaming c : Encoding.StandardNaming.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Encoding.StandardNaming valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null