001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.bind.v2.model.runtime;
038:
039: import java.lang.reflect.Type;
040: import java.util.Collection;
041:
042: import com.sun.xml.bind.v2.model.core.PropertyInfo;
043: import com.sun.xml.bind.v2.runtime.reflect.Accessor;
044:
045: /**
046: * {@link PropertyInfo} that exposes more information.
047: *
048: * @author Kohsuke Kawaguchi (kk@kohsuke.org)
049: */
050: public interface RuntimePropertyInfo extends PropertyInfo<Type, Class> {
051:
052: /** {@inheritDoc} */
053: Collection<? extends RuntimeTypeInfo> ref();
054:
055: /**
056: * Gets the {@link Accessor} for this property.
057: *
058: * <p>
059: * Even for a multi-value property, this method returns an accessor
060: * to that property. IOW, the accessor works against the raw type.
061: *
062: * <p>
063: * This methods returns unoptimized accessor (because optimization
064: * accessors are often combined into bigger pieces, and optimization
065: * generally works better if you can look at a bigger piece, as opposed
066: * to individually optimize a smaller components)
067: *
068: * @return
069: * never null.
070: *
071: * @see Accessor#optimize()
072: */
073: Accessor getAccessor();
074:
075: /**
076: * Returns true if this property has an element-only content. False otherwise.
077: */
078: public boolean elementOnlyContent();
079:
080: /**
081: * Gets the "raw" type of the field.
082: *
083: * The raw type is the actual signature of the property.
084: * For example, if the field is the primitive int, this will be the primitive int.
085: * If the field is Object, this will be Object.
086: * If the property is the collection and typed as {@code Collection<Integer>},
087: * this method returns {@code Collection<Integer>}.
088: *
089: * @return always non-null.
090: */
091: Type getRawType();
092:
093: /**
094: * Gets the type of the individual item.
095: *
096: * The individual type is the signature of the property used to store individual
097: * values. For a non-collection field, this is the same as {@link #getRawType()}.
098: * For acollection property, this is the type used to store individual value.
099: * So if {@link #getRawType()} is {@code Collection<Integer>}, this method will
100: * return {@link Integer}.
101: *
102: * @return always non-null.
103: */
104: Type getIndividualType();
105: }
|