← Back to branch summary

~ubuntu-branches/ubuntu/quantal/simple-xml/quantal

« back to all changes in this revision

Viewing changes to javadoc/org/simpleframework/xml/strategy/Value.html

  • Committer: Bazaar Package Importer
  • Author(s): Sylvestre Ledru, Fabian Köster
  • Date: 2010-03-05 19:44:34 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20100305194434-d9mwhyioc9npo9it
Tags: 2.3.2-1
* Standards-Version updated to version 3.8.4

[ Fabian Köster ]
* New upstream release
* Correct license information in debian/pom.xml
* Exclude generated Javadoc from orig-tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
javadoc/org/simpleframework/xml/strategy/Value.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
 
<!--NewPage-->
3
 
<HTML>
4
 
<HEAD>
5
 
<!-- Generated by javadoc (build 1.5.0_16) on Sat Jan 23 11:55:17 GMT 2010 -->
6
 
<TITLE>
7
 
Value
8
 
</TITLE>
9
 
 
10
 
<META NAME="keywords" CONTENT="org.simpleframework.xml.strategy.Value interface">
11
 
 
12
 
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
 
 
14
 
<SCRIPT type="text/javascript">
15
 
function windowTitle()
16
 
{
17
 
    parent.document.title="Value";
18
 
}
19
 
</SCRIPT>
20
 
<NOSCRIPT>
21
 
</NOSCRIPT>
22
 
 
23
 
</HEAD>
24
 
 
25
 
<BODY BGCOLOR="white" onload="windowTitle();">
26
 
 
27
 
 
28
 
<!-- ========= START OF TOP NAVBAR ======= -->
29
 
<A NAME="navbar_top"><!-- --></A>
30
 
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31
 
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32
 
<TR>
33
 
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34
 
<A NAME="navbar_top_firstrow"><!-- --></A>
35
 
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36
 
  <TR ALIGN="center" VALIGN="top">
37
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39
 
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
44
 
  </TR>
45
 
</TABLE>
46
 
</TD>
47
 
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48
 
</EM>
49
 
</TD>
50
 
</TR>
51
 
 
52
 
<TR>
53
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54
 
&nbsp;<A HREF="../../../../org/simpleframework/xml/strategy/Type.html" title="interface in org.simpleframework.xml.strategy"><B>PREV CLASS</B></A>&nbsp;
55
 
&nbsp;NEXT CLASS</FONT></TD>
56
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57
 
  <A HREF="../../../../index.html?org/simpleframework/xml/strategy/Value.html" target="_top"><B>FRAMES</B></A>  &nbsp;
58
 
&nbsp;<A HREF="Value.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
59
 
&nbsp;<SCRIPT type="text/javascript">
60
 
  <!--
61
 
  if(window==top) {
62
 
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
63
 
  }
64
 
  //-->
65
 
</SCRIPT>
66
 
<NOSCRIPT>
67
 
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
68
 
</NOSCRIPT>
69
 
 
70
 
 
71
 
</FONT></TD>
72
 
</TR>
73
 
<TR>
74
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75
 
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
76
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77
 
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
78
 
</TR>
79
 
</TABLE>
80
 
<A NAME="skip-navbar_top"></A>
81
 
<!-- ========= END OF TOP NAVBAR ========= -->
82
 
 
83
 
<HR>
84
 
<!-- ======== START OF CLASS DATA ======== -->
85
 
<H2>
86
 
<FONT SIZE="-1">
87
 
org.simpleframework.xml.strategy</FONT>
88
 
<BR>
89
 
Interface Value</H2>
90
 
<HR>
91
 
<DL>
92
 
<DT><PRE>public interface <B>Value</B></DL>
93
 
</PRE>
94
 
 
95
 
<P>
96
 
The <code>Value</code> object describes a type that is represented 
97
 
 by an XML element. This enables a <code>Strategy</code> to define
98
 
 not only the type an element represents, but also defines if that
99
 
 type needs to be created. This allows arrays as well as standard
100
 
 object types to be described. When instantiated the instance should
101
 
 be set on the value object for use by the strategy to detect cycles.
102
 
<P>
103
 
 
104
 
<P>
105
 
<DL>
106
 
<DT><B>Author:</B></DT>
107
 
  <DD>Niall Gallagher</DD>
108
 
<DT><B>See Also:</B><DD><A HREF="../../../../org/simpleframework/xml/strategy/Strategy.html" title="interface in org.simpleframework.xml.strategy"><CODE>Strategy</CODE></A></DL>
109
 
<HR>
110
 
 
111
 
<P>
112
 
 
113
 
<!-- ========== METHOD SUMMARY =========== -->
114
 
 
115
 
<A NAME="method_summary"><!-- --></A>
116
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117
 
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118
 
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
119
 
<B>Method Summary</B></FONT></TH>
120
 
</TR>
121
 
<TR BGCOLOR="white" CLASS="TableRowColor">
122
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123
 
<CODE>&nbsp;int</CODE></FONT></TD>
124
 
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/strategy/Value.html#getLength()">getLength</A></B>()</CODE>
125
 
 
126
 
<BR>
127
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This returns the length of the array that is to be allocated.</TD>
128
 
</TR>
129
 
<TR BGCOLOR="white" CLASS="TableRowColor">
130
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131
 
<CODE>&nbsp;java.lang.Class</CODE></FONT></TD>
132
 
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/strategy/Value.html#getType()">getType</A></B>()</CODE>
133
 
 
134
 
<BR>
135
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is the type of the object instance this represents.</TD>
136
 
</TR>
137
 
<TR BGCOLOR="white" CLASS="TableRowColor">
138
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139
 
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
140
 
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/strategy/Value.html#getValue()">getValue</A></B>()</CODE>
141
 
 
142
 
<BR>
143
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is used to acquire an instance of the type that
144
 
 is defined by this object.</TD>
145
 
</TR>
146
 
<TR BGCOLOR="white" CLASS="TableRowColor">
147
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148
 
<CODE>&nbsp;boolean</CODE></FONT></TD>
149
 
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/strategy/Value.html#isReference()">isReference</A></B>()</CODE>
150
 
 
151
 
<BR>
152
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will return true if the object represents a reference.</TD>
153
 
</TR>
154
 
<TR BGCOLOR="white" CLASS="TableRowColor">
155
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156
 
<CODE>&nbsp;void</CODE></FONT></TD>
157
 
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/strategy/Value.html#setValue(java.lang.Object)">setValue</A></B>(java.lang.Object&nbsp;value)</CODE>
158
 
 
159
 
<BR>
160
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is used set the value within this object.</TD>
161
 
</TR>
162
 
</TABLE>
163
 
&nbsp;
164
 
<P>
165
 
 
166
 
<!-- ============ METHOD DETAIL ========== -->
167
 
 
168
 
<A NAME="method_detail"><!-- --></A>
169
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170
 
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
171
 
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
172
 
<B>Method Detail</B></FONT></TH>
173
 
</TR>
174
 
</TABLE>
175
 
 
176
 
<A NAME="getValue()"><!-- --></A><H3>
177
 
getValue</H3>
178
 
<PRE>
179
 
java.lang.Object <B>getValue</B>()</PRE>
180
 
<DL>
181
 
<DD>This method is used to acquire an instance of the type that
182
 
 is defined by this object. If the value has not been set
183
 
 then this method will return null if this is not a reference.
184
 
<P>
185
 
<DD><DL>
186
 
 
187
 
<DT><B>Returns:</B><DD>an instance of the type this object represents</DL>
188
 
</DD>
189
 
</DL>
190
 
<HR>
191
 
 
192
 
<A NAME="setValue(java.lang.Object)"><!-- --></A><H3>
193
 
setValue</H3>
194
 
<PRE>
195
 
void <B>setValue</B>(java.lang.Object&nbsp;value)</PRE>
196
 
<DL>
197
 
<DD>This method is used set the value within this object. Once
198
 
 this is set then the <code>getValue</code> method will return
199
 
 the object that has been provided for consistency.
200
 
<P>
201
 
<DD><DL>
202
 
<DT><B>Parameters:</B><DD><CODE>value</CODE> - this is the value to insert as the type</DL>
203
 
</DD>
204
 
</DL>
205
 
<HR>
206
 
 
207
 
<A NAME="getType()"><!-- --></A><H3>
208
 
getType</H3>
209
 
<PRE>
210
 
java.lang.Class <B>getType</B>()</PRE>
211
 
<DL>
212
 
<DD>This is the type of the object instance this represents. The
213
 
 type returned by this is used to instantiate an object which
214
 
 will be set on this value and the internal graph maintained.
215
 
<P>
216
 
<DD><DL>
217
 
 
218
 
<DT><B>Returns:</B><DD>the type of the object that must be instantiated</DL>
219
 
</DD>
220
 
</DL>
221
 
<HR>
222
 
 
223
 
<A NAME="getLength()"><!-- --></A><H3>
224
 
getLength</H3>
225
 
<PRE>
226
 
int <B>getLength</B>()</PRE>
227
 
<DL>
228
 
<DD>This returns the length of the array that is to be allocated.
229
 
 If this value does not represent an array then this should
230
 
 return zero to indicate that it is not an array object.
231
 
<P>
232
 
<DD><DL>
233
 
 
234
 
<DT><B>Returns:</B><DD>this returns the number of elements for the array</DL>
235
 
</DD>
236
 
</DL>
237
 
<HR>
238
 
 
239
 
<A NAME="isReference()"><!-- --></A><H3>
240
 
isReference</H3>
241
 
<PRE>
242
 
boolean <B>isReference</B>()</PRE>
243
 
<DL>
244
 
<DD>This will return true if the object represents a reference.
245
 
 A reference will provide a valid instance when this objects 
246
 
 getter is invoked. A valid instance can be a null.
247
 
<P>
248
 
<DD><DL>
249
 
 
250
 
<DT><B>Returns:</B><DD>this returns true if this represents a reference</DL>
251
 
</DD>
252
 
</DL>
253
 
<!-- ========= END OF CLASS DATA ========= -->
254
 
<HR>
255
 
 
256
 
 
257
 
<!-- ======= START OF BOTTOM NAVBAR ====== -->
258
 
<A NAME="navbar_bottom"><!-- --></A>
259
 
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
260
 
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
261
 
<TR>
262
 
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
263
 
<A NAME="navbar_bottom_firstrow"><!-- --></A>
264
 
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
265
 
  <TR ALIGN="center" VALIGN="top">
266
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
267
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
268
 
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
269
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
270
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
271
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
272
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
273
 
  </TR>
274
 
</TABLE>
275
 
</TD>
276
 
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
277
 
</EM>
278
 
</TD>
279
 
</TR>
280
 
 
281
 
<TR>
282
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
283
 
&nbsp;<A HREF="../../../../org/simpleframework/xml/strategy/Type.html" title="interface in org.simpleframework.xml.strategy"><B>PREV CLASS</B></A>&nbsp;
284
 
&nbsp;NEXT CLASS</FONT></TD>
285
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
286
 
  <A HREF="../../../../index.html?org/simpleframework/xml/strategy/Value.html" target="_top"><B>FRAMES</B></A>  &nbsp;
287
 
&nbsp;<A HREF="Value.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
288
 
&nbsp;<SCRIPT type="text/javascript">
289
 
  <!--
290
 
  if(window==top) {
291
 
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
292
 
  }
293
 
  //-->
294
 
</SCRIPT>
295
 
<NOSCRIPT>
296
 
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
297
 
</NOSCRIPT>
298
 
 
299
 
 
300
 
</FONT></TD>
301
 
</TR>
302
 
<TR>
303
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
304
 
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
305
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
306
 
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
307
 
</TR>
308
 
</TABLE>
309
 
<A NAME="skip-navbar_bottom"></A>
310
 
<!-- ======== END OF BOTTOM NAVBAR ======= -->
311
 
 
312
 
<HR>
313
 
 
314
 
</BODY>
315
 
</HTML>