/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */


package com.sun.jdo.api.persistence.enhancer.classfile;

/**
 * ClassMember is a common base class for ClassMethod and ClassField
 */

abstract public class ClassMember implements VMConstants {

  /* public accessors */

  /**
   * Is the member static?
   */
  final public boolean isStatic() {
    return (access() & ACCStatic) != 0;
  }

  /**
   * Is the member final?
   */
  final public boolean isFinal() {
    return (access() & ACCFinal) != 0;
  }

  /**
   * Turn on or off the final qualifier for the member.
   */
  public void setIsFinal(boolean newFinal) {
    if (newFinal)
      setAccess(access() | ACCFinal);
    else
      setAccess(access() & ~ACCFinal);
  }

  /**
   * Is the member private?
   */
  final public boolean isPrivate() {
    return (access() & ACCPrivate) != 0;
  }

  /**
   * Is the member protected?
   */
  final public boolean isProtected() {
    return (access() & ACCProtected) != 0;
  }

  /**
   * Is the member public?
   */
  final public boolean isPublic() {
    return (access() & ACCPublic) != 0;
  }

  /* These are expected to be implemented by subtypes */

  /**
   * Return the access flags for the method - see VMConstants
   */
  abstract public int access();

  /**
   * Set the access flags for the method - see VMConstants
   */
  abstract public void setAccess(int newAccess);

  /**
   * Return the name of the member
   */
  abstract public ConstUtf8 name();

  /**
   * Return the type signature of the method
   */
  abstract public ConstUtf8 signature();

  /**
   * Return the attributes associated with the member
   */
  abstract public AttributeVector attributes();

}