/*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
    * with the License.  You may obtain a copy of the License at
    *
   *   https://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  package org.apache.bcel.generic;
  
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.List;
  
  import org.apache.bcel.Const;
  import org.apache.bcel.classfile.AccessFlags;
  import org.apache.bcel.classfile.Attribute;
  
  /**
   * Super class for FieldGen and MethodGen objects, since they have some methods in common!
   */
  public abstract class FieldGenOrMethodGen extends AccessFlags implements NamedAndTyped, Cloneable {
  
      /**
       * @deprecated (since 6.0) will be made private; do not access directly, use getter/setter
       */
      @Deprecated
      protected String name;
  
      /**
       * @deprecated (since 6.0) will be made private; do not access directly, use getter/setter
       */
      @Deprecated
      protected Type type;
  
      /**
       * @deprecated (since 6.0) will be made private; do not access directly, use getter/setter
       */
      @Deprecated
      protected ConstantPoolGen cp;
  
      private final List<Attribute> attributeList = new ArrayList<>();
  
      // @since 6.0
      private final List<AnnotationEntryGen> annotationList = new ArrayList<>();
  
      /**
       * Constructs a FieldGenOrMethodGen.
       */
      protected FieldGenOrMethodGen() {
      }
  
      /**
       * Constructs a FieldGenOrMethodGen.
       *
       * @param accessFlags the access flags.
       * @since 6.0
       */
      protected FieldGenOrMethodGen(final int accessFlags) { // TODO could this be package protected?
          super(accessFlags);
      }
  
      /**
       * Adds all attributes from an array.
       *
       * @param attributes the attributes to add.
       */
      protected void addAll(final Attribute[] attributes) {
          if (attributes != null) {
              Collections.addAll(attributeList, attributes);
          }
      }
  
      /**
       * Adds an annotation entry.
       *
       * @param ag the annotation entry.
       * @since 6.0
       */
      public void addAnnotationEntry(final AnnotationEntryGen ag) {
          annotationList.add(ag);
      }
  
      /**
       * Add an attribute to this method. Currently, the JVM knows about the 'Code', 'ConstantValue', 'Synthetic' and
       * 'Exceptions' attributes. Other attributes will be ignored by the JVM but do no harm.
       *
       * @param a attribute to be added.
       */
     public void addAttribute(final Attribute a) {
         attributeList.add(a);
     }
 
     @Override
     public Object clone() {
         try {
             return super.clone();
         } catch (final CloneNotSupportedException e) {
             throw new UnsupportedOperationException("Clone Not Supported", e); // never happens
         }
     }
 
     /**
      * Gets all annotation entries.
      *
      * @return all annotation entries.
      */
     public AnnotationEntryGen[] getAnnotationEntries() {
         return annotationList.toArray(AnnotationEntryGen.EMPTY_ARRAY);
     }
 
     /**
      * Gets all attributes of this method or field.
      *
      * @return all attributes of this method.
      */
     public Attribute[] getAttributes() {
         return attributeList.toArray(Attribute.EMPTY_ARRAY);
     }
 
     /**
      * Gets the constant pool.
      *
      * @return the constant pool.
      */
     public ConstantPoolGen getConstantPool() {
         return cp;
     }
 
     /**
      * @return name of method/field.
      */
     @Override
     public String getName() {
         return name;
     }
 
     /**
      * Gets the signature of method or field.
      *
      * @return signature of method/field.
      */
     public abstract String getSignature();
 
     @Override
     public Type getType() {
         return type;
     }
 
     /**
      * Removes all annotation entries.
      *
      * @since 6.0
      */
     public void removeAnnotationEntries() {
         annotationList.clear();
     }
 
     /**
      * Removes an annotation entry.
      *
      * @param ag the annotation entry to remove.
      * @since 6.0
      */
     public void removeAnnotationEntry(final AnnotationEntryGen ag) {
         annotationList.remove(ag);
     }
 
     /**
      * Removes an attribute.
      *
      * @param a the attribute to remove.
      */
     public void removeAttribute(final Attribute a) {
         attributeList.remove(a);
     }
 
     /**
      * Removes all attributes.
      */
     public void removeAttributes() {
         attributeList.clear();
     }
 
     /**
      * Sets the constant pool.
      *
      * @param cp the constant pool.
      */
     public void setConstantPool(final ConstantPoolGen cp) { // TODO could be package-protected?
         this.cp = cp;
     }
 
     @Override
     public void setName(final String name) { // TODO could be package-protected?
         this.name = name;
     }
 
     @Override
     public void setType(final Type type) { // TODO could be package-protected?
         if (type.getType() == Const.T_ADDRESS) {
             throw new IllegalArgumentException("Type cannot be " + type);
         }
         this.type = type;
     }
 }