001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 * 
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 * $Id$
020 */
021
022package org.nuxeo.common.xmap.annotation;
023
024import java.lang.annotation.ElementType;
025import java.lang.annotation.Retention;
026import java.lang.annotation.RetentionPolicy;
027import java.lang.annotation.Target;
028
029/**
030 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
031 */
032@XMemberAnnotation(XMemberAnnotation.NODE_MAP)
033@Target({ ElementType.FIELD, ElementType.METHOD })
034@Retention(RetentionPolicy.RUNTIME)
035public @interface XNodeMap {
036
037    /**
038     * A path expression specifying the XML node to bind to.
039     *
040     * @return the node xpath
041     */
042    String value();
043
044    /**
045     * Whether to trim text content for element nodes.
046     */
047    boolean trim() default true;
048
049    /**
050     * The path relative to the current node (which is located by {@link XNodeMap#value()}) which contain the map key to
051     * be used.
052     */
053    String key();
054
055    /**
056     * The type of collection object.
057     */
058    Class type();
059
060    /**
061     * The type of the objects in this collection.
062     *
063     * @return the type of items
064     */
065    Class componentType();
066
067    /**
068     * Whether the container should be set to null when no value is specified.
069     */
070    boolean nullByDefault() default false;
071
072}