Module nl.jqno.equalsverifier
Package nl.jqno.equalsverifier.internal.reflection

Class FieldIterable

java.lang.Object
nl.jqno.equalsverifier.internal.reflection.FieldIterable
All Implemented Interfaces:
Iterable<FieldProbe>
public final class FieldIterable extends Object implements Iterable<FieldProbe>
Iterable to iterate over all declared fields in a class and, if needed, over all declared fields of its superclasses.

  • Field Details

    • type

      private final Class<?> type

    • includeSuperclasses

      private final boolean includeSuperclasses

    • includeStatic

      private final boolean includeStatic

    • isKotlin

      private final boolean isKotlin

  • Constructor Details

    • FieldIterable

      private FieldIterable(Class<?> type, boolean includeSuperclasses, boolean includeStatic, boolean isKotlin)
      Private constructor. Call of(Class) or ofIgnoringSuper(Class) instead.

  • Method Details

    • of

      public static FieldIterable of(Class<?> type)
      Factory method for a FieldIterable that iterates over all declared fields of type and over the declared fields of all of its superclasses.
      Parameters:
      type - The class that contains the fields over which to iterate.
      Returns:
      A FieldIterable.

    • ofKotlin

      public static FieldIterable ofKotlin(Class<?> type)
      Factory method for a FieldIterable that iterates over all declared fields of type and over the declared fields of all of its superclasses, but that ignores overridden Kotlin backing fields in superclasses.
      Parameters:
      type - The class that contains the fields over which to iterate.
      Returns:
      A FieldIterable.

    • ofIgnoringSuper

      public static FieldIterable ofIgnoringSuper(Class<?> type)
      Factory method for a FieldIterable that iterates over all declared fields of type, but that ignores the declared fields of its superclasses.
      Parameters:
      type - The class that contains the fields over which to iterate.
      Returns:
      A FieldIterable.

    • ofIgnoringStatic

      public static FieldIterable ofIgnoringStatic(Class<?> type)
      Factory method for a FieldIterable that iterates over all declared fields of type, but that ignores its static fields.
      Parameters:
      type - The class that contains the fields over which to iterate.
      Returns:
      A FieldIterable.

    • ofIgnoringSuperAndStatic

      public static FieldIterable ofIgnoringSuperAndStatic(Class<?> type)
      Factory method for a FieldIterable that iterates over all declared fields of type, but that ignores its the declared fields of its superclasses, as well as its static fields.
      Parameters:
      type - The class that contains the fields over which to iterate.
      Returns:
      A FieldIterable.

    • iterator

      public Iterator<FieldProbe> iterator()
      Returns an iterator over all declared fields of the class and all of its superclasses.
      Specified by:
      iterator in interface Iterable<FieldProbe>
      Returns:
      An iterator over all declared fields of the class and all of its superclasses.

    • createFieldList

      private List<FieldProbe> createFieldList()

    • createJavaFieldList

      private List<FieldProbe> createJavaFieldList()

    • createKotlinFieldList

      private List<FieldProbe> createKotlinFieldList()

    • addFieldsFor

      private List<FieldProbe> addFieldsFor(Class<?> c)