Class ClassResult

chasm/src/main/java/org/quiltmc/chasm/api/ClassResult.java:10–86

The result type used for org.quiltmc.chasm.api.ChasmProcessor#process().

 * The result type used for {@link org.quiltmc.chasm.api.ChasmProcessor#process()}.
 */
public class ClassResult {
    private final byte @Nullable [] classBytes;

    private final @NotNull Metadata metadata;

    private final @NotNull Type type;

    /**
     * Create a new {@link ClassResult}.
     *
     * @param classBytes The bytes representing the class of this result,
     *     or {@code null} if {@code type = Type.Removed}.
     * @param metadata The metadata associated with the class of this result.
     * @param type The {@link Type} of this result.
     */
    public ClassResult(byte @Nullable [] classBytes, @NotNull Metadata metadata, @NotNull Type type) {
        this.classBytes = classBytes;
        this.metadata = metadata;
        this.type = type;
    }

    /**
     * Get the bytes representing the class of this result.
     * This will be {@code null} if and only if {@link #getType} is {@link Type#REMOVED}.
     *
     * @return The bytes representing the class of this result,
     *     or {@code null} if {@link #getType} is {@link Type#REMOVED}.
     */
    public byte @Nullable [] getClassBytes() {
        return classBytes;
    }

    /**
     * Get the {@link Metadata} associated with the class of this result.
     *
     * @return The {@link Metadata} of the class.
     */
    public @NotNull Metadata getMetadata() {
        return metadata;
    }

    /**
     * Get the {@link Type} of this result.
     *
     * @return The {@link Type} of this result.
     */
    public @NotNull Type getType() {
        return type;
    }

    /**
     * Represents the possible outcomes of {@link ClassResult}.
     */
    public enum Type {
        /**
         * Indicates that the class hasn't been modified during processing.
         * Note that this doesn't apply to {@link org.quiltmc.chasm.lang.api.metadata.Metadata}.
         */