Package com.blamejared.crafttweaker.api.natives

Record Class NativeTypeInfo.Constructor

java.lang.Object
java.lang.Record
com.blamejared.crafttweaker.api.natives.NativeTypeInfo.Constructor
Record Components:
description - The description of the constructor, acting as documentation, or empty if no description is to be provided.
sinceVersion - The first version of the API this constructor was exposed in, acting as documentation, or empty if no initial version is to be provided.
deprecationMessage - The message that accompanies a deprecation warning for this constructor, or empty if the constructor is not deprecated.
parameters - The NativeTypeInfo.Parameters accepted by this constructor.
Enclosing class:
NativeTypeInfo
public static record NativeTypeInfo.Constructor(String description, String sinceVersion, String deprecationMessage, NativeTypeInfo.Parameter[] parameters) extends Record
Holds information relative to a specific native constructor that should be exposed to ZenCode.
Since:
9.1.0

  • Constructor Details

    • Constructor

      public Constructor(String description, String sinceVersion, NativeTypeInfo.Parameter... parameters)
      Creates an instance holding information relative to a native constructor that should be exposed to ZenCode.

      The created constructor is not deprecated.

      Parameters:
      description - The description of the constructor, acting as documentation, or empty if no description is to be provided.
      sinceVersion - The first version of the API this constructor was exposed in, acting as documentation, or empty if no initial version is to be provided.
      parameters - The NativeTypeInfo.Parameters accepted by this constructor.
      Since:
      9.1.0

    • Constructor

      public Constructor(String description, NativeTypeInfo.Parameter... parameters)
      Creates an instance holding information relative to a native constructor that should be exposed to ZenCode.

      The created constructor is not deprecated and no initial exposure version is provided.

      Parameters:
      description - The description of the constructor, acting as documentation, or empty if no description is to be provided.
      parameters - The NativeTypeInfo.Parameters accepted by this constructor.
      Since:
      9.1.0

    • Constructor

      public Constructor(NativeTypeInfo.Parameter... parameters)
      Creates an instance holding information relative to a native constructor that should be exposed to ZenCode.

      The created constructor is not deprecated, no initial exposure version is provided, and it has no description.

      Parameters:
      parameters - The NativeTypeInfo.Parameters accepted by this constructor.
      Since:
      9.1.0

    • Constructor

      public Constructor(String description, String sinceVersion, String deprecationMessage, NativeTypeInfo.Parameter... parameters)
      Creates an instance of a Constructor record class.
      Parameters:
      description - the value for the description record component
      sinceVersion - the value for the sinceVersion record component
      deprecationMessage - the value for the deprecationMessage record component
      parameters - the value for the parameters 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • description

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

    • sinceVersion

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

    • deprecationMessage

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

    • parameters

      public NativeTypeInfo.Parameter[] parameters()
      Returns the value of the parameters record component.
      Returns:
      the value of the parameters record component