Package ghidra.program.model.data

Enum Composite.AlignmentType

  • All Implemented Interfaces:
    Composite.NamedAlignment, java.io.Serializable, java.lang.Comparable<Composite.AlignmentType>
    Enclosing interface:
    Composite
    public static enum Composite.AlignmentType
extends java.lang.Enum<Composite.AlignmentType>
implements Composite.NamedAlignment
    AlignmentType defined the three states for the type of alignment of a composite data type. This can be default aligned, machine aligned or aligned by value.
    This controls how this data type will be aligned within other data types.
    Default Aligned means to determine this data type's alignment based upon the alignments of its components. This is controlled by the Data Organization that is provided by its data type manager. If there is no data type manager then a default data organization is used.
    Machine Aligned means this data type's alignment will use a minimum alignment that is the machine alignment specified by the data organization.
    Align By Value means that a "minimum alignment value", which is a power of 2 and specified elsewhere, will affect the alignment so that it will be at least the indicated value and will be a multiple of the minimum value and of the default value.
    Note: If the data organization specifies a maximum alignment, other than 0, then the alignment value will not be allowed to exceed the maximum alignment for any of these types.

    • Method Detail

      • values

        public static Composite.AlignmentType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Composite.AlignmentType c : Composite.AlignmentType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Composite.AlignmentType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<Composite.AlignmentType>