001: package org.tigris.scarab.util.xmlissues;
002:
003: /* ================================================================
004: * Copyright (c) 2000-2002 CollabNet. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are
008: * met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in the
015: * documentation and/or other materials provided with the distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowlegement: "This product includes
019: * software developed by Collab.Net <http://www.Collab.Net/>."
020: * Alternately, this acknowlegement may appear in the software itself, if
021: * and wherever such third-party acknowlegements normally appear.
022: *
023: * 4. The hosted project names must not be used to endorse or promote
024: * products derived from this software without prior written
025: * permission. For written permission, please contact info@collab.net.
026: *
027: * 5. Products derived from this software may not use the "Tigris" or
028: * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
029: * prior written permission of Collab.Net.
030: *
031: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
032: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
033: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
034: * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
035: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
036: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
037: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
038: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
039: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
040: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
041: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
042: *
043: * ====================================================================
044: *
045: * This software consists of voluntary contributions made by many
046: * individuals on behalf of Collab.Net.
047: */
048:
049: import java.util.AbstractCollection;
050: import java.util.ArrayList;
051: import java.util.Collection;
052: import java.util.Iterator;
053:
054: import org.apache.commons.collections.iterators.EmptyIterator;
055:
056: /**
057: * A lazily constructed <code>Collection</code> implementation which
058: * records the list of any errors which occur during an import.
059: *
060: * @since Scarab 0.16.29
061: */
062: class ImportErrors extends AbstractCollection {
063: /**
064: * Internal storage for the list of errors.
065: */
066: private Collection errors;
067:
068: /**
069: * Contextual information recorded while parsing.
070: */
071: private Object parseContext = null;
072:
073: public ImportErrors() {
074: }
075:
076: public Iterator iterator() {
077: return (errors == null ? EmptyIterator.INSTANCE : errors
078: .iterator());
079: }
080:
081: public int size() {
082: return (errors == null ? 0 : errors.size());
083: }
084:
085: /**
086: * Adds <code>error</code>, possibly annotated using any current
087: * contextual information.
088: *
089: * @param error An error which will <code>toString()</code>
090: * nicely.
091: * @see #setParseContext(Object)
092: */
093: public boolean add(Object error) {
094: if (errors == null) {
095: errors = new ArrayList();
096: }
097: if (parseContext != null) {
098: // Format error as an object which toString()'s nicely
099: // using any applicable contextual state.
100: error = '[' + parseContext.toString() + "] " + error;
101: }
102: return errors.add(error);
103: }
104:
105: /**
106: * Pushes contextual information onto {@link #parseContext} to
107: * help identify exactly where errors occur, empowering users to
108: * resolve any data formatting problems.
109: *
110: * @param parseContext The current parse context. A value of
111: * <code>null</code> indicates that any current state should be
112: * cleared.
113: */
114: public void setParseContext(Object parseContext) {
115: this.parseContext = parseContext;
116: }
117: }
|