KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jibx > runtime > impl > BackFillHolder


1 /*
2 Copyright (c) 2002,2003, Dennis M. Sosnoski.
3 All rights reserved.
4
5 Redistribution and use in source and binary forms, with or without modification,
6 are permitted provided that the following conditions are met:
7
8  * Redistributions of source code must retain the above copyright notice, this
9    list of conditions and the following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice,
11    this list of conditions and the following disclaimer in the documentation
12    and/or other materials provided with the distribution.
13  * Neither the name of JiBX nor the names of its contributors may be used
14    to endorse or promote products derived from this software without specific
15    prior written permission.
16
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
21 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 package org.jibx.runtime.impl;
30
31 import java.util.ArrayList JavaDoc;
32
33 /**
34  * Holder used to collect forward references to a particular object. The
35  * references are processed when the object is defined.
36  *
37  * @author Dennis M. Sosnoski
38  * @version 1.0
39  */
40
41 public class BackFillHolder
42 {
43     /** Expected class name of tracked object. */
44     private String JavaDoc m_class;
45     
46     /** List of references to this object. */
47     private ArrayList JavaDoc m_list;
48     
49     /**
50      * Constructor. Just creates the backing list.
51      *
52      * @param name expected class name of tracked object
53      */
54      
55     public BackFillHolder(String JavaDoc name) {
56         m_class = name;
57         m_list = new ArrayList JavaDoc();
58     }
59     
60     /**
61      * Add forward reference to tracked object. This method is called by
62      * the framework when a reference item is created for the object
63      * associated with this holder.
64      *
65      * @param ref backfill reference item
66      */
67     
68     public void addBackFill(BackFillReference ref){
69         m_list.add(ref);
70     }
71     
72     /**
73      * Define referenced object. This method is called by the framework
74      * when the forward-referenced object is defined, and in turn calls each
75      * reference to fill in the reference.
76      *
77      * @param obj referenced object
78      */
79     
80     public void defineValue(Object JavaDoc obj) {
81         for (int i = 0; i < m_list.size(); i++) {
82             BackFillReference ref = (BackFillReference)m_list.get(i);
83             ref.backfill(obj);
84         }
85     }
86     
87     /**
88      * Get expected class name of referenced object.
89      *
90      * @return expected class name of referenced object
91      */
92     
93     public String JavaDoc getExpectedClass() {
94         return m_class;
95     }
96 }
97
Popular Tags