KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > util > xmlissues > ImportErrors


1 package org.tigris.scarab.util.xmlissues;
2
3 /* ================================================================
4  * Copyright (c) 2000-2002 CollabNet. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by Collab.Net <http://www.Collab.Net/>."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" or
28  * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
29  * prior written permission of Collab.Net.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  * ====================================================================
44  *
45  * This software consists of voluntary contributions made by many
46  * individuals on behalf of Collab.Net.
47  */
48
49 import java.util.AbstractCollection JavaDoc;
50 import java.util.ArrayList JavaDoc;
51 import java.util.Collection JavaDoc;
52 import java.util.Iterator JavaDoc;
53
54 import org.apache.commons.collections.IteratorUtils;
55
56 /**
57  * A lazily constructed <code>Collection</code> implementation which
58  * records the list of any errors which occur during an import.
59  *
60  * @since Scarab 0.16.29
61  */
62 class ImportErrors extends AbstractCollection JavaDoc
63 {
64     /**
65      * Internal storage for the list of errors.
66      */
67     private Collection JavaDoc errors;
68
69     /**
70      * Contextual information recorded while parsing.
71      */
72     private Object JavaDoc parseContext = null;
73
74     public ImportErrors()
75     {
76     }
77
78     public Iterator JavaDoc iterator()
79     {
80         return (errors == null ?
81                 IteratorUtils.EMPTY_ITERATOR : errors.iterator());
82     }
83
84     public int size()
85     {
86         return (errors == null ? 0 : errors.size());
87     }
88
89     /**
90      * Adds <code>error</code>, possibly annotated using any current
91      * contextual information.
92      *
93      * @param error An error which will <code>toString()</code>
94      * nicely.
95      * @see #setParseContext(Object)
96      */
97     public boolean add(Object JavaDoc error)
98     {
99         if (errors == null)
100         {
101             errors = new ArrayList JavaDoc();
102         }
103         if (parseContext != null)
104         {
105             // Format error as an object which toString()'s nicely
106 // using any applicable contextual state.
107 error = '[' + parseContext.toString() + "] " + error;
108         }
109         return errors.add(error);
110     }
111
112     /**
113      * Pushes contextual information onto {@link #parseContext} to
114      * help identify exactly where errors occur, empowering users to
115      * resolve any data formatting problems.
116      *
117      * @param parseContext The current parse context. A value of
118      * <code>null</code> indicates that any current state should be
119      * cleared.
120      */
121     public void setParseContext(Object JavaDoc parseContext)
122     {
123         this.parseContext = parseContext;
124     }
125 }
126
Popular Tags