Package io.keikai.axyra.sheets.content

Record Class VbaModule

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.content.VbaModule
public record VbaModule(String name, String kind, String source) extends Record
A VBA code module extracted from a macro-enabled workbook's vbaProject.bin (read-only): its editor name, kind, and decompressed source text.

kind is "standard" (a normal code module), "class" (a class module), or "document" (the ThisWorkbook / per-sheet code-behind modules). The source is the MS-OVBA-decompressed text; the reader does not execute or modify it, and a read → save round-trip preserves vbaProject.bin byte-for-byte.

  • Constructor Summary

    Constructors
    Constructor
    Description
    VbaModule(String name, String kind, String source)
    Creates an instance of a VbaModule record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static VbaModule
    fromMap(Map<String,Object> m)
    Builds a VbaModule from a decoded JSON object.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    kind()
    Returns the value of the kind record component.
    String
    name()
    Returns the value of the name record component.
    String
    source()
    Returns the value of the source record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • VbaModule

      public VbaModule(String name, String kind, String source)
      Creates an instance of a VbaModule record class.
      Parameters:
      name - the value for the name record component
      kind - the value for the kind record component
      source - the value for the source record component

  • Method Details

    • fromMap

      public static VbaModule fromMap(Map<String,Object> m)
      Builds a VbaModule from a decoded JSON object.

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

    • name

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

    • kind

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

    • source

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