Package dev.getelements.elements.sdk.record

Record Class ElementDefinitionRecord

java.lang.Object
java.lang.Record
dev.getelements.elements.sdk.record.ElementDefinitionRecord
Record Components:
name - the name of the element
recursive - true, if recursive
loader - the loader typ
public record ElementDefinitionRecord(Package pkg, String name, boolean recursive, List<ElementPackageRecord> additionalPackages, Class<? extends ElementLoader> loader) extends Record
Represents the record pertaining to the ElementDefinition annotation.

  • Constructor Details

    • ElementDefinitionRecord

      public ElementDefinitionRecord(Package pkg, String name, boolean recursive, List<ElementPackageRecord> additionalPackages, Class<? extends ElementLoader> loader)
      Creates an instance of a ElementDefinitionRecord record class.
      Parameters:
      pkg - the value for the pkg record component
      name - the value for the name record component
      recursive - the value for the recursive record component
      additionalPackages - the value for the additionalPackages record component
      loader - the value for the loader record component

  • Method Details

    • pkgName

      public String pkgName()
      A shortcut to get the Package name.
      Returns:
      the Package name.

    • acceptPackages

      public void acceptPackages(Consumer<String> recursive, Consumer<String> nonRecursive)
      Iterates over all defined packages in this ElementDefinition, calling the Consumer for each defined (including the defining package).
      Parameters:
      recursive - called for package defined as recursive
      nonRecursive - called for a pakage defined as non-recursive

    • isPartOfElement

      public boolean isPartOfElement(Class<?> aClass)
      Checks if the supplied Class is part of the Element attached to this record.
      Parameters:
      aClass - a Class
      Returns:
      true if part of this Element, false otherwise

    • isPartOfElement

      public boolean isPartOfElement(Package aPackage)
      Checks if the supplied Package is part of the Element attached to this record.
      Parameters:
      aPackage - a Package
      Returns:
      true if part of this Element, false otherwise

    • fromPackage

      public static ElementDefinitionRecord fromPackage(Package aPackage)
      Gets a ElementDefinitionRecord from a Package
      Parameters:
      aPackage - a package
      Returns:
      a ElementDefinitionRecord

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

    • pkg

      public Package pkg()
      Returns the value of the pkg record component.
      Returns:
      the value of the pkg record component

    • name

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

    • recursive

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

    • additionalPackages

      public List<ElementPackageRecord> additionalPackages()
      Returns the value of the additionalPackages record component.
      Returns:
      the value of the additionalPackages record component

    • loader

      public Class<? extends ElementLoader> loader()
      Returns the value of the loader record component.
      Returns:
      the value of the loader record component