001    /*
002      GRANITE DATA SERVICES
003      Copyright (C) 2013 GRANITE DATA SERVICES S.A.S.
004    
005      This file is part of Granite Data Services.
006    
007      Granite Data Services is free software; you can redistribute it and/or modify
008      it under the terms of the GNU Library General Public License as published by
009      the Free Software Foundation; either version 2 of the License, or (at your
010      option) any later version.
011    
012      Granite Data Services is distributed in the hope that it will be useful, but
013      WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
014      FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License
015      for more details.
016    
017      You should have received a copy of the GNU Library General Public License
018      along with this library; if not, see <http://www.gnu.org/licenses/>.
019    */
020    
021    package org.granite.messaging.annotations;
022    
023    import java.lang.annotation.Documented;
024    import java.lang.annotation.ElementType;
025    import java.lang.annotation.Retention;
026    import java.lang.annotation.RetentionPolicy;
027    import java.lang.annotation.Target;
028    
029    /**
030     * The <tt>Include</tt> annotation can be used to include a property with no
031     * corresponding Java field and which content has to be retrieved from a getter.
032     * <p>
033     * Typical usage:
034     * <pre>
035     * @Include
036     * public String getComputedData() {
037     *     return "something that can only be computed on the server";
038     * }
039     * </pre>
040     * The pseudo-field will be serialized just like if there were a field named
041     * "calculatedData". The implementation accepts the get/is convention of Java
042     * beans. Note that even if the client is actually serializing non empty data
043     * when the property is sent back to the server, its content will be ignored
044     * on the server side.
045     * </p>
046     * 
047     * @author Franck WOLFF
048     */
049    @Documented
050    @Retention(RetentionPolicy.RUNTIME)
051    @Target({ElementType.METHOD})
052    public @interface Include {
053    
054    }