Project Report: fawkez

Packagesummary org.jcoderz.commons.config

org.jcoderz.commons.config.ConfigurationCacheInterface

LineHitsNoteSource
1  /*
2   * $Id: ConfigurationCacheInterface.java 1011 2008-06-16 17:57:36Z amandel $
3   *
4   * Copyright 2006, The jCoderZ.org Project. 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   *    * Redistributions of source code must retain the above copyright
11   *      notice, this list of conditions and the following disclaimer.
12   *    * Redistributions in binary form must reproduce the above
13   *      copyright notice, this list of conditions and the following
14   *      disclaimer in the documentation and/or other materials
15   *      provided with the distribution.
16   *    * Neither the name of the jCoderZ.org Project nor the names of
17   *      its contributors may be used to endorse or promote products
18   *      derived from this software without specific prior written
19   *      permission.
20   *
21   * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
22   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24   * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS
25   * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30   * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32   */
33  package org.jcoderz.commons.config;
34  
35  import java.util.Set;
36  
37  import org.jcoderz.commons.ArgumentMalformedException;
38  
39  
40  /**
41   * ConfigurationCache Interface.
42   * This level is introduced to allow different cache implementations and
43   * backends.
44   * These are needed to reflect both development phases and newer technical
45   * approaches.
46   *
47   */
48 (1)public interface ConfigurationCacheInterface
49  {
50  
51     /**
52      * Returns the String value that is associated with the given key.
53      *
54      * @param key Configuration Key as string that is the key for a stored
55      *         configuration value.
56      * @return the String value that is associated with the given key.
57      * @throws ConfigurationValueNotFoundException in case there is no match to
58      *         the key.
59      * @throws ArgumentMalformedException Is thrown to indicate the illegal use
60      *         of a null object as input parameter.
61      */
62     String getString (String key)
63           throws ConfigurationValueNotFoundException,
64                  ArgumentMalformedException;
65  
66  
67     /**
68      * Returns an immutable Set containing all keys present in the
69      * configuration. The keys are <code>ConfigurationKey</code> objects.
70      * In case there are no keys, the Set is empty.
71      *
72      * @return the Set of all existing <code>ConfigurationKey</code> objects.
73      */
74     Set getKeys ();
75  
76     /**
77      * @see ConfigurationServiceInterface#addConfigurationListener(ConfigurationListener)
78      */
79 (2)   void addConfigurationListener (ConfigurationListener newListener);
80  
81     /**
82      * Reloads the internal configuration cache from resource bundle.
83      * If an exception occurs during the reload, the old cached properties are
84      * returned.
85      */
86     void reloadCache ();
87  }

Findings in this File

c (1) 48 : 0 Type Javadoc comment is missing an @author tag.
c (2) 79 : 57 Expected @param tag for 'newListener'.