/*
 * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.sun.max.vm.classfile.constant;

import static com.sun.max.vm.classfile.ErrorContext.*;

import java.io.*;

import com.sun.max.vm.classfile.constant.ConstantPool.*;

import com.sun.max.vm.classfile.constant.ConstantPool.Tag;

/**
 * Place holder for invalid constant pool indexes such as 0 and the indexes immediately after a {@link Tag#LONG} or
 * {@link Tag#DOUBLE} entry.
 */
public final class InvalidConstant extends AbstractPoolConstant<InvalidConstant> {

    private InvalidConstant() {

    }

    @Override
    public PoolConstantKey<InvalidConstant> key(ConstantPool pool) {
        throw classFormatError("Invalid constant pool entry");
    }

    @Override
    public Tag tag() {
        return Tag.INVALID;
    }

    public String valueString(ConstantPool pool) {
        return "--INVALID--";
    }

    public static final InvalidConstant VALUE = new InvalidConstant();

    @Override
    public void writeOn(DataOutputStream stream, ConstantPoolEditor editor, int index) throws IOException {
        // NOOP
    }
}