Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/tools/internal/xjc/outline/FieldAccessor.java@f50545b5e2f1 (annotated)
src/share/jaxws_classes/com/sun/tools/internal/xjc/outline/FieldAccessor.java
Tue, 06 Mar 2012 16:09:35 -0800
- author
- ohair
- date
- Tue, 06 Mar 2012 16:09:35 -0800
- changeset 286
- f50545b5e2f1
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.tools.internal.xjc.outline; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.codemodel.internal.JBlock; |
| aoqi@0 | 29 | import com.sun.codemodel.internal.JExpression; |
| aoqi@0 | 30 | import com.sun.codemodel.internal.JVar; |
| aoqi@0 | 31 | import com.sun.tools.internal.xjc.model.CPropertyInfo; |
| aoqi@0 | 32 | |
| aoqi@0 | 33 | /** |
| aoqi@0 | 34 | * Encapsulates the access on a field. |
| aoqi@0 | 35 | * |
| aoqi@0 | 36 | * @author |
| aoqi@0 | 37 | * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
| aoqi@0 | 38 | */ |
| aoqi@0 | 39 | public interface FieldAccessor { |
| aoqi@0 | 40 | |
| aoqi@0 | 41 | /** |
| aoqi@0 | 42 | * Dumps everything in this field into the given variable. |
| aoqi@0 | 43 | * |
| aoqi@0 | 44 | * <p> |
| aoqi@0 | 45 | * This generates code that accesses the field from outside. |
| aoqi@0 | 46 | * |
| aoqi@0 | 47 | * @param block |
| aoqi@0 | 48 | * The code will be generated into this block. |
| aoqi@0 | 49 | * @param $var |
| aoqi@0 | 50 | * Variable whose type is {@link FieldOutline#getRawType()} |
| aoqi@0 | 51 | */ |
| aoqi@0 | 52 | void toRawValue( JBlock block, JVar $var ); |
| aoqi@0 | 53 | |
| aoqi@0 | 54 | /** |
| aoqi@0 | 55 | * Sets the value of the field from the specified expression. |
| aoqi@0 | 56 | * |
| aoqi@0 | 57 | * <p> |
| aoqi@0 | 58 | * This generates code that accesses the field from outside. |
| aoqi@0 | 59 | * |
| aoqi@0 | 60 | * @param block |
| aoqi@0 | 61 | * The code will be generated into this block. |
| aoqi@0 | 62 | * @param uniqueName |
| aoqi@0 | 63 | * Identifier that the caller guarantees to be unique in |
| aoqi@0 | 64 | * the given block. When the callee needs to produce additional |
| aoqi@0 | 65 | * variables, it can do so by adding suffixes to this unique |
| aoqi@0 | 66 | * name. For example, if the uniqueName is "abc", then the |
| aoqi@0 | 67 | * caller guarantees that any identifier "abc.*" is unused |
| aoqi@0 | 68 | * in this block. |
| aoqi@0 | 69 | * @param $var |
| aoqi@0 | 70 | * The expression that evaluates to a value of the type |
| aoqi@0 | 71 | * {@link FieldOutline#getRawType()}. |
| aoqi@0 | 72 | */ |
| aoqi@0 | 73 | void fromRawValue( JBlock block, String uniqueName, JExpression $var ); |
| aoqi@0 | 74 | |
| aoqi@0 | 75 | /** |
| aoqi@0 | 76 | * Generates a code fragment to remove any "set" value |
| aoqi@0 | 77 | * and move this field to the "unset" state. |
| aoqi@0 | 78 | * |
| aoqi@0 | 79 | * @param body |
| aoqi@0 | 80 | * The code will be appended at the end of this block. |
| aoqi@0 | 81 | */ |
| aoqi@0 | 82 | void unsetValues( JBlock body ); |
| aoqi@0 | 83 | |
| aoqi@0 | 84 | /** |
| aoqi@0 | 85 | * Return an expression that evaluates to true only when |
| aoqi@0 | 86 | * this field has a set value(s). |
| aoqi@0 | 87 | * |
| aoqi@0 | 88 | * @return null |
| aoqi@0 | 89 | * if the isSetXXX/unsetXXX method does not make sense |
| aoqi@0 | 90 | * for the given field. |
| aoqi@0 | 91 | */ |
| aoqi@0 | 92 | JExpression hasSetValue(); |
| aoqi@0 | 93 | |
| aoqi@0 | 94 | /** |
| aoqi@0 | 95 | * Gets the {@link FieldOutline} from which |
| aoqi@0 | 96 | * this object is created. |
| aoqi@0 | 97 | */ |
| aoqi@0 | 98 | FieldOutline owner(); |
| aoqi@0 | 99 | |
| aoqi@0 | 100 | /** |
| aoqi@0 | 101 | * Short for <tt>owner().getPropertyInfo()</tt> |
| aoqi@0 | 102 | */ |
| aoqi@0 | 103 | CPropertyInfo getPropertyInfo(); |
| aoqi@0 | 104 | } |
