Examples of org.exolab.javasource.JAnnotation

org.exolab.javasource.JAnnotation

JAnnotation represents a single annotation against a code element. The methods described on the JAnnotatedElement interface are used to associate JAnnotation's with various other objects in this package describing Java code elements.

The print method outputs annotations in various forms (as described in the Java Language Specification Third Edition) based on the methods called.

For "Marker Annotation", construct with the appropriate JAnnotationType.

 JAnnotationType preliminaryType = new JAnnotationType("Preliminary"); JAnnotation preliminary = new JAnnotation(preliminaryType);

outputs

 @Preliminary()

For "Single Element Annotation", construct as above and call the setValue(value) method to set the value of the "value" element of the annotation type.

 JAnnotationType copyrightType = new JAnnotationType("Copyright"); JAnnotation copyright = new JAnnotation(copyrightType); copyright.setValue("\"2002 Yoyodyne Systems, Inc., All rights reserved.\"");

outputs

 @Copyright("2002 Yoyodyne Propulsion Systems, Inc., All rights reserved.")

For "Normal Annotation," construct as above then call the appropriate setValue methods that accept an "elementName" parameter.

 JAnnotationType requestType = new JAnnotationType("RequestForEnhancement"); JAnnotation request = new JAnnotation(requestType); request.setElementValue("id", "2868724"); request.setElementValue("synopsis", "\"Provide time-travel functionality\""); request.setElementValue("engineer", "\"Mr. Peabody\""); request.setElementValue("date", "\"4/1/2004\"");

outputs

 @RequestForEnhancement( id       = 2868724, sysopsis = "Provide time-travel functionality", engineer = "Mr. Peabody", date     = "4/1/2004")

"Complex" annotations are also supported via the various setValue methods that take a JAnnotation object.

 JAnnotationType nameType = new JAnnotationType("Name"); JAnnotationType authorType = new JAnnotationType("Author"); JAnnotation author = new JAnnotation(authorType); JAnnotation name = new JAnnotation(nameType); name.setElementValue("first", "\"Joe\""); name.setElementValue("last", "\"Hacker\""); author.setValue(name);

outputs

 @Author(@Name( first = "Joe", last  = "Hacker"))

Finally annotation elements whose types are arrays are supported via the setValue methods that take arrays:

 JAnnotationType endorsersType = new JAnnotationType("Endorsers"); JAnnotation endorsers = new JAnnotation(endorsersType); endorsers.setValue(new String[] { "\"Children\"", "\"Unscrupulous dentists\""});

outputs

 @Endorsers( { "Children", "Unscrupulous dentists" })

Note: Conditional element values are not currently supported. However the setValue methods taking String values can be used to output this construct literally if desired. @author Andrew Fawcett @version $Revision: 8009 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

        //-- create getNameSpacePrefix method
        method = new JMethod("getNameSpacePrefix", SGTypes.STRING,
                             "the namespace prefix to use when marshaling as XML.");


        if (_config.useJava50()) {
            method.addAnnotation(new JAnnotation(new JAnnotationType("Override")));
        }


        jsc = method.getSourceCode();
        jsc.add("return _nsPrefix;");
        addMethod(method);


        //-- create getNameSpaceURI method
        method = new JMethod("getNameSpaceURI", SGTypes.STRING,
                             "the namespace URI used when marshaling and unmarshaling as XML.");


        if (_config.useJava50()) {
            method.addAnnotation(new JAnnotation(new JAnnotationType("Override")));
        }


        jsc = method.getSourceCode();
        jsc.add("return _nsURI;");
        addMethod(method);


        //-- create getValidator method
        method = new JMethod("getValidator", TYPE_VALIDATOR_CLASS,
                             "a specific validator for the class described"
                             + " by this ClassDescriptor.");


        if (_config.useJava50()) {
            method.addAnnotation(new JAnnotation(new JAnnotationType("Override")));
        }


        jsc = method.getSourceCode();
        jsc.add("return this;");
        addMethod(method);


        //-- create getXMLName method
        method = new JMethod("getXMLName", SGTypes.STRING,
                             "the XML Name for the Class being described.");


        if (_config.useJava50()) {
            method.addAnnotation(new JAnnotation(new JAnnotationType("Override")));
        }


        jsc = method.getSourceCode();
        jsc.add("return _xmlName;");
        addMethod(method);

View Full Code Here

        JClass amClass = new JClass(MAPPING_ACCESS_MODE);
        JMethod getAccessMode = new JMethod("getAccessMode", amClass,
                                     "the access mode specified for this class.");


        if (_config.useJava50()) {
            getAccessMode.addAnnotation(new JAnnotation(new JAnnotationType("Override")));
        }


        jsc = getAccessMode.getSourceCode();
        jsc.add("return null;");
        addMethod(getAccessMode);


        //-- create getIdentity method
        JMethod getIdentity = new JMethod("getIdentity", FIELD_DESCRIPTOR_CLASS,
                                   "the identity field, null if this class has no identity.");


        if (_config.useJava50()) {
            getIdentity.addAnnotation(new JAnnotation(new JAnnotationType("Override")));
        }


        jsc = getIdentity.getSourceCode();
        if (extended) {
            jsc.add("if (_identity == null) {");
            jsc.indent();
            jsc.add("return super.getIdentity();");
            jsc.unindent();
            jsc.add("}");
        }
        jsc.add("return _identity;");


        //--don't add the type to the import list
        addMethod(getIdentity, false);


        //-- create getJavaClass method
        JMethod getJavaClass = new JMethod("getJavaClass", SGTypes.CLASS,
                                    "the Java class represented by this descriptor.");


        if (_config.useJava50()) {
            getJavaClass.addAnnotation(new JAnnotation(new JAnnotationType("Override")));
        }


        jsc = getJavaClass.getSourceCode();
        jsc.add("return ");
        jsc.append(classType(_type));

View Full Code Here

    private String printAnnotationValue(final Object elementValue, final String shift) {
        // String?
        if (elementValue instanceof String) {
            return (String) elementValue;
        } else if (elementValue instanceof JAnnotation) {
            JAnnotation annotation = (JAnnotation) elementValue;
            return printAnnotation(annotation, shift);
        } else if (elementValue.getClass().isArray()) {
            // Short hand for single item list
            int listLength = Array.getLength(elementValue);
            if (listLength == 1) {

View Full Code Here

     */
    private void initialize(final JClass jClass) {
        jClass.addInterface("java.io.Serializable");


        if (getConfig().useJava50()) {
            JAnnotation serial = new JAnnotation(new JAnnotationType("SuppressWarnings"));
            serial.setValue(new String[] {"\"serial\""});
            jClass.addAnnotation(serial);
        }


        //-- add default constructor
        JConstructor con = jClass.createConstructor();

View Full Code Here

        JMethod jMethod = new JMethod("equals", JType.BOOLEAN, "true if the objects are equal.");
        jMethod.setComment("Overrides the java.lang.Object.equals method.");
        jMethod.addParameter(new JParameter(SGTypes.OBJECT, "obj"));


        if (getConfig().useJava50()) {
            jMethod.addAnnotation(new JAnnotation(new JAnnotationType("Override")));
        }


        jclass.addMethod(jMethod);
        JSourceCode jsc = jMethod.getSourceCode();
        jsc.add("if ( this == obj )");

View Full Code Here

TOP

Related Classes of org.exolab.javasource.JAnnotation

org.exolab.castor.builder.descriptors.DescriptorJClass

org.exolab.castor.builder.factory.SourceFactory

org.exolab.castor.builder.printing.TemplateHelper

java.io.PrintWriter

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.