Project Report: fawkez

Packagesummary org.jcoderz.phoenix.sqlparser

org.jcoderz.phoenix.sqlparser.FkConstraint

LineHitsNoteSource
1  /*
2   * $Id: FkConstraint.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.phoenix.sqlparser;
34  
35  import java.util.ArrayList;
36  import java.util.List;
37  
38  /**
39 (1) * TODO Write javadoc!
40   * 
41   * @author Albrecht Messner
42   */
43  public class FkConstraint
44  {
45     private final String mName;
46     private final List mColumns;
47     private final String mRefTable;
48     private final List mRefColumns;
49  
50 (2)   public FkConstraint (
51           String name, List columns, String refTable, List refColumns)
520    {
530       mName = name;
540       mColumns = columns;
550       mRefTable = refTable;
560       mRefColumns = refColumns;
570    }
58     
59 (3)   public FkConstraint (
60           String name, String column, String refTable, String refColumn)
610    {
620       mName = name;
630       final List colList = new ArrayList();
640       colList.add(column);
650       mColumns = colList;
660       mRefTable = refTable;
670       final List refList = new ArrayList();
680       refList.add(refColumn);
690       mRefColumns = refList;
700    }
71     
72     /**
73      * @return Returns the name.
74      */
75     public String getName ()
76     {
770       return mName;
78     }
79     
80     /**
81      * @return Returns the columns.
82      */
83     public List getColumns ()
84     {
850       return mColumns;
86     }
87     
88     /**
89      * @return Returns the refTable.
90      */
91     public String getRefTable ()
92     {
930       return mRefTable;
94     }
95     
96     /**
97      * @return Returns the refColumns.
98      */
99     public List getRefColumns ()
100     {
1010       return mRefColumns;
102     }
103     
104     /** {@inheritDoc} */
105     public String toString ()
106     {
1070       return "[FkConstraint columns: " + getColumns() + " references "
108              + getRefTable() + "(" + getRefColumns() + ")]";
109     }
110  }

Findings in this File

i (1) 39 : 0 Comment matches to-do format '(TODO|FIXME|CHECKME)'.
c (2) 50 : 4 Missing a Javadoc comment.
c (3) 59 : 4 Missing a Javadoc comment.