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