com.sun.codemodel.JAnnotationArrayMember Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. 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://oss.oracle.com/licenses/CDDL+GPL-1.1
* or 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 LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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.codemodel;
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
*
*
* This class implements {@link JAnnotatable} to allow
* new annotations to be added as a member of the array.
*
* @author
* Bhakti Mehta ([email protected])
*/
public final class JAnnotationArrayMember extends JAnnotationValue implements JAnnotatable {
private final List values = new ArrayList();
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 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 boolean removeAnnotation(JAnnotationUse annotation) {
return this.values.remove(annotation);
}
public W annotate2(Class clazz) {
return TypedAnnotationWriter.create(clazz,this);
}
/**
* {@link JAnnotatable#annotations()}
*/
@SuppressWarnings("unchecked")
public Collection 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.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('}');
}
}