Mir goes GPL
[mir.git] / source / mir / producer / reader / ReaderTool.java
1 /*
2  * Copyright (C) 2001, 2002  The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with the com.oreilly.servlet library, any library
22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
24  * the above that use the same license as the above), and distribute linked
25  * combinations including the two.  You must obey the GNU General Public
26  * License in all respects for all of the code used other than the above
27  * mentioned libraries.  If you modify this file, you may extend this exception
28  * to your version of the file, but you are not obligated to do so.  If you do
29  * not wish to do so, delete this exception statement from your version.
30  */
31
32 package mir.producer.reader;
33
34 import java.util.*;
35
36 public class ReaderTool {
37
38   public static void checkValidIdentifier(String anIdentifier) throws ProducerConfigExc {
39   }
40
41   public static String getStringAttributeWithDefault(Map anAttributes, String aKey, String aDefault) {
42     if (anAttributes.containsKey(aKey))
43       return (String) anAttributes.get(aKey);
44     else
45       return aDefault;
46   }
47
48   public static void checkIntegerAttribute(Map anAttributes, String aKey) throws ProducerConfigExc {
49     try {
50       Integer.parseInt((String) anAttributes.get(aKey));
51     }
52     catch (Throwable t) {
53       throw new ProducerConfigExc("attribute '"+aKey+"' is not an integer" );
54     }
55   }
56
57   public static int getIntegerAttributeWithDefault(Map anAttributes, String aKey, int aDefault) throws ProducerConfigExc  {
58     String value;
59
60     if (anAttributes.containsKey(aKey)) {
61       checkIntegerAttribute(anAttributes, aKey);
62       return Integer.parseInt((String) anAttributes.get(aKey));
63     }
64     else
65       return aDefault;
66   }
67
68   public static void checkAttributes(Map anAttributes, String[] aRequiredAttributes, String[] anOptionalAttributes)  throws ProducerConfigExc {
69     checkAttributeSet(anAttributes.keySet(),
70        new HashSet(Arrays.asList(aRequiredAttributes)),
71        new HashSet(Arrays.asList(anOptionalAttributes)));
72   }
73
74   public static void checkAttributeSet(Set aSet, Set aRequiredElements, Set anOptionalElements) throws ProducerConfigExc{
75     Iterator i;
76
77     i = aSet.iterator();
78     while (i.hasNext()) {
79       Object item = i.next();
80
81       if (!(aRequiredElements.contains(item) || anOptionalElements.contains(item)))
82         throw new ProducerConfigExc("unknown attribute '" + item + "'" );
83     }
84
85     i = aRequiredElements.iterator();
86     while (i.hasNext()) {
87       Object item = i.next();
88
89       if (!(aSet.contains(item)))
90         throw new ProducerConfigExc("missing required attribute '" + item + "'" );
91     }
92
93   }
94 }