source: libjibx-java-1.1/trunk/fuentes/docs/api/org/jibx/runtime/impl/BackFillHolder.html @ 4701

Last change on this file since 4701 was 4701, checked in by Juanma, 3 years ago

Port to xenial

File size: 11.2 KB
Line 
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.6.0_02) on Sun Jun 08 22:06:27 NZST 2008 -->
6<TITLE>
7BackFillHolder (JiBX Java data binding to XML - Version 1.1.6a)
8</TITLE>
9
10<META NAME="date" CONTENT="2008-06-08">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="BackFillHolder (JiBX Java data binding to XML - Version 1.1.6a)";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</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/jibx/runtime/impl/BackFillArray.html" title="class in org.jibx.runtime.impl"><B>PREV CLASS</B></A>&nbsp;
55&nbsp;<A HREF="../../../../org/jibx/runtime/impl/BackFillReference.html" title="interface in org.jibx.runtime.impl"><B>NEXT CLASS</B></A></FONT></TD>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57  <A HREF="../../../../index.html?org/jibx/runtime/impl/BackFillHolder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
58&nbsp;<A HREF="BackFillHolder.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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">
87org.jibx.runtime.impl</FONT>
88<BR>
89Class BackFillHolder</H2>
90<PRE>
91java.lang.Object
92  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.jibx.runtime.impl.BackFillHolder</B>
93</PRE>
94<HR>
95<DL>
96<DT><PRE>public class <B>BackFillHolder</B><DT>extends java.lang.Object</DL>
97</PRE>
98
99<P>
100Holder used to collect forward references to a particular object. The
101 references are processed when the object is defined.
102<P>
103
104<P>
105<DL>
106<DT><B>Version:</B></DT>
107  <DD>1.0</DD>
108<DT><B>Author:</B></DT>
109  <DD>Dennis M. Sosnoski</DD>
110</DL>
111<HR>
112
113<P>
114
115<!-- ======== CONSTRUCTOR SUMMARY ======== -->
116
117<A NAME="constructor_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121<B>Constructor Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD><CODE><B><A HREF="../../../../org/jibx/runtime/impl/BackFillHolder.html#BackFillHolder(java.lang.String)">BackFillHolder</A></B>(java.lang.String&nbsp;name)</CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
128</TR>
129</TABLE>
130&nbsp;
131<!-- ========== METHOD SUMMARY =========== -->
132
133<A NAME="method_summary"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
136<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
137<B>Method Summary</B></FONT></TH>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>&nbsp;void</CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../org/jibx/runtime/impl/BackFillHolder.html#addBackFill(org.jibx.runtime.impl.BackFillReference)">addBackFill</A></B>(<A HREF="../../../../org/jibx/runtime/impl/BackFillReference.html" title="interface in org.jibx.runtime.impl">BackFillReference</A>&nbsp;ref)</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add forward reference to tracked object.</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<CODE>&nbsp;void</CODE></FONT></TD>
150<TD><CODE><B><A HREF="../../../../org/jibx/runtime/impl/BackFillHolder.html#defineValue(java.lang.Object)">defineValue</A></B>(java.lang.Object&nbsp;obj)</CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Define referenced object.</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../../org/jibx/runtime/impl/BackFillHolder.html#getExpectedClass()">getExpectedClass</A></B>()</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get expected class name of referenced object.</TD>
162</TR>
163</TABLE>
164&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
165<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
167<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
171</TR>
172</TABLE>
173&nbsp;
174<P>
175
176<!-- ========= CONSTRUCTOR DETAIL ======== -->
177
178<A NAME="constructor_detail"><!-- --></A>
179<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
180<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
181<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
182<B>Constructor Detail</B></FONT></TH>
183</TR>
184</TABLE>
185
186<A NAME="BackFillHolder(java.lang.String)"><!-- --></A><H3>
187BackFillHolder</H3>
188<PRE>
189public <B>BackFillHolder</B>(java.lang.String&nbsp;name)</PRE>
190<DL>
191<DD>Constructor. Just creates the backing list.
192<P>
193<DL>
194<DT><B>Parameters:</B><DD><CODE>name</CODE> - expected class name of tracked object</DL>
195</DL>
196
197<!-- ============ METHOD DETAIL ========== -->
198
199<A NAME="method_detail"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
203<B>Method Detail</B></FONT></TH>
204</TR>
205</TABLE>
206
207<A NAME="addBackFill(org.jibx.runtime.impl.BackFillReference)"><!-- --></A><H3>
208addBackFill</H3>
209<PRE>
210public void <B>addBackFill</B>(<A HREF="../../../../org/jibx/runtime/impl/BackFillReference.html" title="interface in org.jibx.runtime.impl">BackFillReference</A>&nbsp;ref)</PRE>
211<DL>
212<DD>Add forward reference to tracked object. This method is called by
213 the framework when a reference item is created for the object
214 associated with this holder.
215<P>
216<DD><DL>
217<DT><B>Parameters:</B><DD><CODE>ref</CODE> - backfill reference item</DL>
218</DD>
219</DL>
220<HR>
221
222<A NAME="defineValue(java.lang.Object)"><!-- --></A><H3>
223defineValue</H3>
224<PRE>
225public void <B>defineValue</B>(java.lang.Object&nbsp;obj)</PRE>
226<DL>
227<DD>Define referenced object. This method is called by the framework
228 when the forward-referenced object is defined, and in turn calls each
229 reference to fill in the reference.
230<P>
231<DD><DL>
232<DT><B>Parameters:</B><DD><CODE>obj</CODE> - referenced object</DL>
233</DD>
234</DL>
235<HR>
236
237<A NAME="getExpectedClass()"><!-- --></A><H3>
238getExpectedClass</H3>
239<PRE>
240public java.lang.String <B>getExpectedClass</B>()</PRE>
241<DL>
242<DD>Get expected class name of referenced object.
243<P>
244<DD><DL>
245
246<DT><B>Returns:</B><DD>expected class name of referenced object</DL>
247</DD>
248</DL>
249<!-- ========= END OF CLASS DATA ========= -->
250<HR>
251
252
253<!-- ======= START OF BOTTOM NAVBAR ====== -->
254<A NAME="navbar_bottom"><!-- --></A>
255<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
256<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
257<TR>
258<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
259<A NAME="navbar_bottom_firstrow"><!-- --></A>
260<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
261  <TR ALIGN="center" VALIGN="top">
262  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
263  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
264  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
265  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
266  </TR>
267</TABLE>
268</TD>
269<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
270</EM>
271</TD>
272</TR>
273
274<TR>
275<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
276&nbsp;<A HREF="../../../../org/jibx/runtime/impl/BackFillArray.html" title="class in org.jibx.runtime.impl"><B>PREV CLASS</B></A>&nbsp;
277&nbsp;<A HREF="../../../../org/jibx/runtime/impl/BackFillReference.html" title="interface in org.jibx.runtime.impl"><B>NEXT CLASS</B></A></FONT></TD>
278<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
279  <A HREF="../../../../index.html?org/jibx/runtime/impl/BackFillHolder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
280&nbsp;<A HREF="BackFillHolder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
281&nbsp;<SCRIPT type="text/javascript">
282  <!--
283  if(window==top) {
284    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
285  }
286  //-->
287</SCRIPT>
288<NOSCRIPT>
289  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
290</NOSCRIPT>
291
292
293</FONT></TD>
294</TR>
295<TR>
296<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
297  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
298<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
299DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
300</TR>
301</TABLE>
302<A NAME="skip-navbar_bottom"></A>
303<!-- ======== END OF BOTTOM NAVBAR ======= -->
304
305<HR>
306<table width='80%%'><tr><td width='50%%'><p align='center'><a href='http://www.jibx.org/' target='_top'><font size='3'><b>Project Web Site</b></font></a></td><td width='50%%'><p align='center'></td></tr></table>
307</BODY>
308</HTML>
Note: See TracBrowser for help on using the repository browser.