aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.v2.model.runtime;
aoqi@0: 
aoqi@0: import java.lang.reflect.Type;
aoqi@0: import java.util.Collection;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.bind.v2.model.core.PropertyInfo;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.reflect.Accessor;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * {@link PropertyInfo} that exposes more information.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi (kk@kohsuke.org)
aoqi@0:  */
aoqi@0: public interface RuntimePropertyInfo extends PropertyInfo<Type,Class> {
aoqi@0: 
aoqi@0:     /** {@inheritDoc} */
aoqi@0:     Collection<? extends RuntimeTypeInfo> ref();
aoqi@0: 
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the {@link Accessor} for this property.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * Even for a multi-value property, this method returns an accessor
aoqi@0:      * to that property. IOW, the accessor works against the raw type.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This methods returns unoptimized accessor (because optimization
aoqi@0:      * accessors are often combined into bigger pieces, and optimization
aoqi@0:      * generally works better if you can look at a bigger piece, as opposed
aoqi@0:      * to individually optimize a smaller components)
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      never null.
aoqi@0:      *
aoqi@0:      * @see Accessor#optimize()
aoqi@0:      */
aoqi@0:     Accessor getAccessor();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns true if this property has an element-only content. False otherwise.
aoqi@0:      */
aoqi@0:     public boolean elementOnlyContent();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the "raw" type of the field.
aoqi@0:      *
aoqi@0:      * The raw type is the actual signature of the property.
aoqi@0:      * For example, if the field is the primitive int, this will be the primitive int.
aoqi@0:      * If the field is Object, this will be Object.
aoqi@0:      * If the property is the collection and typed as {@code Collection<Integer>},
aoqi@0:      * this method returns {@code Collection<Integer>}.
aoqi@0:      *
aoqi@0:      * @return always non-null.
aoqi@0:      */
aoqi@0:     Type getRawType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the type of the individual item.
aoqi@0:      *
aoqi@0:      * The individual type is the signature of the property used to store individual
aoqi@0:      * values. For a non-collection field, this is the same as {@link #getRawType()}.
aoqi@0:      * For acollection property, this is the type used to store individual value.
aoqi@0:      * So if {@link #getRawType()} is {@code Collection<Integer>}, this method will
aoqi@0:      * return {@link Integer}.
aoqi@0:      *
aoqi@0:      * @return always non-null.
aoqi@0:      */
aoqi@0:     Type getIndividualType();
aoqi@0: }