/*

 * Copyright 2005-2006 Sun Microsystems, Inc.  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.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package com.sun.codemodel.internal;

import java.io.PrintWriter;

import java.io.StringWriter;

/**

 * Modifier groups.

 */

public class JMods implements JGenerable {

//

// mask

//

    private static int VAR

        = JMod.FINAL;

    private static int FIELD

    private static int METHOD

    private static int CLASS

    private static int INTERFACE = JMod.PUBLIC;

    /** bit-packed representation of modifiers. */

    private int mods;

    private JMods(int mods) {

        this.mods = mods;

    }

    /**

     * Gets the bit-packed representaion of modifiers.

     */

    public int getValue() {

        return mods;

    }

    private static void check(int mods, int legal, String what) {

        if ((mods & ~legal) != 0)

            throw new IllegalArgumentException("Illegal modifiers for "

                    + what + ": "

                    + new JMods(mods).toString());

        /* ## check for illegal combinations too */

    }

    static JMods forVar(int mods) {

        check(mods, VAR, "variable");

        return new JMods(mods);

    }

    static JMods forField(int mods) {

        check(mods, FIELD, "field");

        return new JMods(mods);

    }

    static JMods forMethod(int mods) {

        check(mods, METHOD, "method");

        return new JMods(mods);

    }

    static JMods forClass(int mods) {

        check(mods, CLASS, "class");

        return new JMods(mods);

    }

    static JMods forInterface(int mods) {

        check(mods, INTERFACE, "class");

        return new JMods(mods);

    }

    public boolean isAbstract() {

        return (mods & JMod.ABSTRACT) != 0;

    }

    public boolean isNative() {

        return (mods & JMod.NATIVE) != 0;

    }

    public boolean isSynchronized() {

        return (mods & JMod.SYNCHRONIZED) != 0;

    }

    public void setSynchronized(boolean newValue) {

        setFlag( JMod.SYNCHRONIZED, newValue );

    }

    // TODO: more

    private void setFlag( int bit, boolean newValue ) {

        mods = (mods & ~bit) | (newValue?bit:0);

    }

    public void generate(JFormatter f) {

        if ((mods & JMod.PUBLIC) != 0)        f.p("public");

        if ((mods & JMod.PROTECTED) != 0)     f.p("protected");

        if ((mods & JMod.PRIVATE) != 0)       f.p("private");

        if ((mods & JMod.FINAL) != 0)         f.p("final");

        if ((mods & JMod.STATIC) != 0)        f.p("static");

        if ((mods & JMod.ABSTRACT) != 0)      f.p("abstract");

        if ((mods & JMod.NATIVE) != 0)        f.p("native");

        if ((mods & JMod.SYNCHRONIZED) != 0)  f.p("synchronized");

        if ((mods & JMod.TRANSIENT) != 0)     f.p("transient");

        if ((mods & JMod.VOLATILE) != 0)      f.p("volatile");

    }

    public String toString() {

        StringWriter s = new StringWriter();

        JFormatter f = new JFormatter(new PrintWriter(s));

        this.generate(f);

        return s.toString();

    }

}