Record Class LedgerSectionWriter.Options

java.lang.Object
java.lang.Record
network.ike.plugin.schema.LedgerSectionWriter.Options
Record Components:
packageName - the generated class's package
className - the generated class's simple name
tag - the fully-qualified-name tag, ELM, written in parentheses after every label
labelPrefix - the prefix labels carry when their namespace has no prefix of its own, ELM , also the prefix of the family's own concepts
prefixByNamespace - the label prefix per namespace, ELM System for the System types; a namespace absent here uses labelPrefix
attribution - who the definitions come from, for example the ELM specification
pin - the version the schemas were taken from, for example a repository tag
stampExpression - the Java expression of the inception stamp, Ike.INCEPTION
termsClass - the class holding field data-type constants, IkeTerm
rootParentExpression - the Java expression of the family root's parent, IkeTerm.MODEL_CONCEPT
Enclosing class:
LedgerSectionWriter
public static record LedgerSectionWriter.Options(String packageName, String className, String tag, String labelPrefix, Map<String,String> prefixByNamespace, String attribution, String pin, String stampExpression, String termsClass, String rootParentExpression) extends Record
What the writer needs beyond the signature.

  • Constructor Details

    • Options

      public Options(String packageName, String className, String tag, String labelPrefix, Map<String,String> prefixByNamespace, String attribution, String pin, String stampExpression, String termsClass, String rootParentExpression)
      Creates the options, copying the prefix map.
      Parameters:
      packageName - the package
      className - the class name
      tag - the tag
      labelPrefix - the default label prefix
      prefixByNamespace - the prefix per namespace
      attribution - the attribution
      pin - the pin
      stampExpression - the stamp expression
      termsClass - the terms class
      rootParentExpression - the root parent expression

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

    • packageName

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

    • className

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

    • tag

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

    • labelPrefix

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

    • prefixByNamespace

      public Map<String,String> prefixByNamespace()
      Returns the value of the prefixByNamespace record component.
      Returns:
      the value of the prefixByNamespace record component

    • attribution

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

    • pin

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

    • stampExpression

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

    • termsClass

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

    • rootParentExpression

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