Record Class NamingRuleOptions

java.lang.Object
java.lang.Record
dev.archunitjava.rules.NamingRuleOptions
public record NamingRuleOptions(boolean includeAnonymousTypes, boolean includeLocalTypes, boolean includeGeneratedSubjects, Set<String> generatedAnnotationBinaryNames) extends Record
Explicit opt-ins for subjects commonly created by compilers or generators.

  • Constructor Details

    • NamingRuleOptions

      public NamingRuleOptions(boolean includeAnonymousTypes, boolean includeLocalTypes, boolean includeGeneratedSubjects, Set<String> generatedAnnotationBinaryNames)
      Creates an instance of a NamingRuleOptions record class.
      Parameters:
      includeAnonymousTypes - the value for the includeAnonymousTypes record component
      includeLocalTypes - the value for the includeLocalTypes record component
      includeGeneratedSubjects - the value for the includeGeneratedSubjects record component
      generatedAnnotationBinaryNames - the value for the generatedAnnotationBinaryNames record component

  • Method Details

    • defaults

      public static NamingRuleOptions defaults()

    • includingAnonymousTypes

      public NamingRuleOptions includingAnonymousTypes()

    • includingLocalTypes

      public NamingRuleOptions includingLocalTypes()

    • includingGeneratedSubjects

      public NamingRuleOptions includingGeneratedSubjects()
      Includes generated types as well as synthetic or bridge members.

    • includingGeneratedTypes

      public NamingRuleOptions includingGeneratedTypes()
      Compatibility alias for the original type-oriented option name.

    • includeGeneratedTypes

      public boolean includeGeneratedTypes()
      Compatibility accessor for the original type-oriented option name.

    • withGeneratedAnnotationBinaryNames

      public NamingRuleOptions withGeneratedAnnotationBinaryNames(Set<String> names)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • includeAnonymousTypes

      public boolean includeAnonymousTypes()
      Returns the value of the includeAnonymousTypes record component.
      Returns:
      the value of the includeAnonymousTypes record component

    • includeLocalTypes

      public boolean includeLocalTypes()
      Returns the value of the includeLocalTypes record component.
      Returns:
      the value of the includeLocalTypes record component

    • includeGeneratedSubjects

      public boolean includeGeneratedSubjects()
      Returns the value of the includeGeneratedSubjects record component.
      Returns:
      the value of the includeGeneratedSubjects record component

    • generatedAnnotationBinaryNames

      public Set<String> generatedAnnotationBinaryNames()
      Returns the value of the generatedAnnotationBinaryNames record component.
      Returns:
      the value of the generatedAnnotationBinaryNames record component