com.tangosol.dev.assembler.PackageConstant Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation
Oracle Coherence Community Edition
There is a newer version: 24.09
/*
 * Copyright (c) 2022, Oracle and/or its affiliates.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 * http://oss.oracle.com/licenses/upl.
 */
package com.tangosol.dev.assembler;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;

/**
 * PackageConstant represents a package.
 * 
 * The Package Constant was defined by JDK 9 under bytecode version 53.0. The
 * structure is defined as:
 * 

 * 
 * CONSTANT_Package_info
 *     {
 *     u1 tag;
 *     u2 name_index;
 *     }
 * 
 *
 * @author Aleks Seovic  2022.04.09
 */
public class PackageConstant
        extends Constant
    {
    // ----- constructors ---------------------------------------------------

    /**
     * Construct a PackageConstant (tag = 20).
     */
    protected PackageConstant()
        {
        super(CONSTANT_PACKAGE);
        }

    // ----- Constant methods -----------------------------------------------

    /**
     * {@inheritDoc}
     */
    @Override
    protected void disassemble(DataInput stream, ConstantPool pool)
            throws IOException
        {
        m_nNameIndex = stream.readUnsignedShort();
        }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void postdisassemble(ConstantPool pool)
        {
        m_name = (UtfConstant) pool.getConstant(m_nNameIndex);
        }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void preassemble(ConstantPool pool)
        {
        pool.registerConstant(m_name);
        }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void assemble(DataOutput stream, ConstantPool pool)
            throws IOException
        {
        super.assemble(stream, pool);

        stream.writeShort(pool.findConstant(m_name));
        }

    // ----- Comparable methods ---------------------------------------------

    /**
     * {@inheritDoc}
     */
    @Override
    public int compareTo(Object obj)
        {
        return obj instanceof PackageConstant
               ? m_name.compareTo(((PackageConstant) obj).m_name)
               : 1;
        }

    // ----- Object methods -------------------------------------------------

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString()
        {
        return "(Package)->[name = " + m_name + "]";
        }

    /**
     * {@inheritDoc}
     */
    @Override
    public String format()
        {
        return m_name.format();
        }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object obj)
        {
        return obj instanceof PackageConstant
               && m_name.equals(((PackageConstant) obj).m_name);
        }

    // ----- accessors ------------------------------------------------------

    /**
     * Returns the package name.
     *
     * @return the package name
     */
    public UtfConstant getName()
        {
        return m_name;
        }

    /**
     * Sets the package name.
     *
     * @param name the package name
     */
    public void setName(UtfConstant name)
        {
        m_name = name;
        }

    // ----- data members ---------------------------------------------------

    /**
     * The ConstantPool index of the package name.
     */
    private int m_nNameIndex;

    /**
     * The Constant that contains package name.
     */
    private UtfConstant m_name;
    }