Project Report: fawkez

Packagesummary org.jcoderz.commons.config

org.jcoderz.commons.config.ServiceConfiguration

LineHitsNoteSource
1  /*
2   * $Id: ServiceConfiguration.java 1067 2008-07-08 19:13:20Z 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   
36  /**
37   * The ServiceConfiguration Interface is the super interface
38   * for all derived *Service*Configuration interfaces that provide
39   * typed interface methods to get the configuration parameters that belong
40   * to the corresponding *Service*.
41   *
42   */
43 (1)public interface ServiceConfiguration
44  {
45     // currently no common method for all interfaces
46   
47     /**
48      * selects the cache mode,if the types interface implementation should cache
49      * its configuration. The caching is enabled by default.
50      *
51      * NOTE: Please remark that this caching mode only determines the caching
52      * for the typed interface level. This is independent from the data access
53      * level where a separated caching might be available dependent to its
54      * implementation.
55      *
56      * @param doCaching if true, caching is enabled. if false no caching
57      *       at the type interface level will be used.
58      */
59     void enableCaching (boolean doCaching);
60   
61  }
62   

Findings in this File

c (1) 43 : 0 Type Javadoc comment is missing an @author tag.