Record Class ModelRelationshipTraversal.Policy

java.lang.Object
java.lang.Record
io.fluxzero.common.modeling.ModelRelationshipTraversal.Policy
Enclosing class:
ModelRelationshipTraversal
public static record ModelRelationshipTraversal.Policy(int maxDepth, int maxModels, boolean rejectDepthOverflow, boolean revisitAtDifferentDepths, String maxModelsMessage, String maxDepthMessage) extends Record
Traversal bounds and the failure messages associated with exceeding them.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Policy(int maxDepth, int maxModels, boolean rejectDepthOverflow, boolean revisitAtDifferentDepths, String maxModelsMessage, String maxDepthMessage)
    Creates an instance of a Policy record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxDepth()
    Returns the value of the maxDepth record component.
    String
    maxDepthMessage()
    Returns the value of the maxDepthMessage record component.
    int
    maxModels()
    Returns the value of the maxModels record component.
    String
    maxModelsMessage()
    Returns the value of the maxModelsMessage record component.
    boolean
    rejectDepthOverflow()
    Returns the value of the rejectDepthOverflow record component.
    boolean
    revisitAtDifferentDepths()
    Returns the value of the revisitAtDifferentDepths record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Policy

      public Policy(int maxDepth, int maxModels, boolean rejectDepthOverflow, boolean revisitAtDifferentDepths, String maxModelsMessage, String maxDepthMessage)
      Creates an instance of a Policy record class.
      Parameters:
      maxDepth - the value for the maxDepth record component
      maxModels - the value for the maxModels record component
      rejectDepthOverflow - the value for the rejectDepthOverflow record component
      revisitAtDifferentDepths - the value for the revisitAtDifferentDepths record component
      maxModelsMessage - the value for the maxModelsMessage record component
      maxDepthMessage - the value for the maxDepthMessage record component

  • Method Details

    • 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.

    • maxDepth

      public int maxDepth()
      Returns the value of the maxDepth record component.
      Returns:
      the value of the maxDepth record component

    • maxModels

      public int maxModels()
      Returns the value of the maxModels record component.
      Returns:
      the value of the maxModels record component

    • rejectDepthOverflow

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

    • revisitAtDifferentDepths

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

    • maxModelsMessage

      public String maxModelsMessage()
      Returns the value of the maxModelsMessage record component.
      Returns:
      the value of the maxModelsMessage record component

    • maxDepthMessage

      public String maxDepthMessage()
      Returns the value of the maxDepthMessage record component.
      Returns:
      the value of the maxDepthMessage record component