/*

 * Copyright (c) 1997, 2010, 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.  Oracle designates this

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

 * by Oracle 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 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.codemodel.internal;

import java.lang.annotation.Annotation;

import java.util.ArrayList;

import java.util.List;

import java.util.Collection;

import java.util.Collections;

/**

 * Represents an arrays as annotation members

 *

 * <p>

 * This class implements {@link JAnnotatable} to allow

 * new annotations to be added as a member of the array.

 *

 * @author

 *     Bhakti Mehta (bhakti.mehta@sun.com)

 */

public final class JAnnotationArrayMember extends JAnnotationValue implements JAnnotatable {

    private final List<JAnnotationValue> values = new ArrayList<JAnnotationValue>();

    private final JCodeModel owner;

    JAnnotationArrayMember(JCodeModel owner) {

        this.owner = owner;

    }

    /**

     * Adds an array member to this annotation

     *

     * @param value Adds a string value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(String value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(JExpr.lit(value));

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds an array member to this annotation

     *

     * @param value Adds a boolean value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(boolean value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(JExpr.lit(value));

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds an array member to this annotation

     *

     * @param value Adds a byte value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(byte value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(JExpr.lit(value));

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds an array member to this annotation

     *

     * @param value Adds a char value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(char value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(JExpr.lit(value));

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds an array member to this annotation

     *

     * @param value Adds a double value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(double value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(JExpr.lit(value));

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds an array member to this annotation

     *

     * @param value Adds a long value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(long value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(JExpr.lit(value));

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds an array member to this annotation

     *

     * @param value Adds a short value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(short value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(JExpr.lit(value));

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds an array member to this annotation

     *

     * @param value Adds an int value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(int value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(JExpr.lit(value));

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds an array member to this annotation

     *

     * @param value Adds a float value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(float value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(JExpr.lit(value));

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds a enum array member to this annotation

     *

     * @param value Adds a enum value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(final Enum<?> value) {

        JAnnotationValue annotationValue = new JAnnotationValue() {

            public void generate(JFormatter f) {

                f.t(owner.ref(value.getDeclaringClass())).p('.').p(value.name());

            }

        };

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds a enum array member to this annotation

     *

     * @param value Adds a enum value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(final JEnumConstant value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(value);

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds an expression array member to this annotation

     *

     * @param value Adds an expression value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(final JExpression value) {

        JAnnotationValue annotationValue = new JAnnotationStringValue(value);

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds a class array member to this annotation

     *

     * @param value Adds a class value to the array member

     * @return The JAnnotationArrayMember. More elements can be added by calling

     *         the same method multiple times

     */

    public JAnnotationArrayMember param(final Class<?> value){

       JAnnotationValue annotationValue = new JAnnotationStringValue(

                   new JExpressionImpl() {

                         public void generate(JFormatter f) {

                                 f.p(value.getName().replace('$', '.'));

                                 f.p(".class");

                        }

                 });

       values.add(annotationValue);

       return this;

   }

    public JAnnotationArrayMember param(JType type){

        JClass clazz = type.boxify();

        JAnnotationValue annotationValue = new JAnnotationStringValue ( clazz.dotclass() );

        values.add(annotationValue);

        return this;

    }

    /**

     * Adds a new annotation to the array.

     */

    public JAnnotationUse annotate(Class<? extends Annotation> clazz){

        return annotate(owner.ref(clazz));

    }

    /**

     * Adds a new annotation to the array.

     */

    public JAnnotationUse annotate(JClass clazz){

        JAnnotationUse a = new JAnnotationUse(clazz);

        values.add(a);

        return a;

    }

    public <W extends JAnnotationWriter> W annotate2(Class<W> clazz) {

        return TypedAnnotationWriter.create(clazz,this);

    }

    /**

     * {@link JAnnotatable#annotations()}

     */

    @SuppressWarnings("unchecked")

        public Collection<JAnnotationUse> annotations() {

        // this invocation is invalid if the caller isn't adding annotations into an array

        // so this potentially type-unsafe conversion would be justified.

        return Collections.<JAnnotationUse>unmodifiableList((List)values);

    }

    /**

     * Adds an annotation member to this annotation  array

     * This can be used for e.g @XmlCollection(values= @XmlCollectionItem(type=Foo.class))

     * @param value

     *        Adds a annotation  to the array member

     * @return

     *        The JAnnotationArrayMember. More elements can be added by calling

     *        the same method multiple times

     *

     * @deprecated

     *      use {@link #annotate}

     */

    public JAnnotationArrayMember param (JAnnotationUse value ){

        values.add(value);

        return this;

    }

    public void generate(JFormatter f) {

        f.p('{').nl().i();

        boolean first = true;

        for (JAnnotationValue aValue : values) {

            if (!first)

                f.p(',').nl();

            f.g(aValue);

            first = false;

        }

        f.nl().o().p('}');

    }

}