Changeset 4040


Ignore:
Timestamp:
Dec 5, 2007, 4:49:05 PM (16 years ago)
Author:
Martin Svensson
Message:

Fixes #847 Most of the missing javadocs tags have been added in the public API.

Location:
trunk/src
Files:
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/core/net/sf/basedb/core/ItemModifiedException.java

    r3679 r4040  
    5858    item is specified in the message like:
    5959    <code>[net.sf.basedb.core.data.XxxxData#id]</code>.
     60    @param ex Exception generated by Hibernate.
    6061  */
    6162  public ItemModifiedException(org.hibernate.StaleStateException ex)
    … …  
    6667  /**
    6768    A pattern to extract the <code>Xxxx</code> and <code>id</code> parts
    68     from a string containting <code>[net.sf.basedb.core.data.XxxxData#id]</code>.
     69    from a string containing <code>[net.sf.basedb.core.data.XxxxData#id]</code>.
    6970  */
    7071  private static final Pattern FIND_WHAT = Pattern.compile("\\[net\\.sf\\.basedb\\.core\\.data\\.(\\w+)Data\\#(\\d+)\\]");

  • trunk/src/core/net/sf/basedb/core/Message.java

    r3679 r4040  
    5656    @param dc The <code>DbControl</code> which will be used for
    5757      permission checking and database access
     58    @param to The user who should receive the message.
     59    @param fromName Name of the sender.
     60    @param fromUser The user who sends this message.
     61    @param job Which job this message is about.
    5862    @return The new <code>Message</code> item
    5963    @throws BaseException If there is an error

  • trunk/src/core/net/sf/basedb/core/NameableUtil.java

    r3679 r4040  
    4040  /**
    4141    Set the name of a {@link NameableData} object.
     42    @param nameableData A NameableData object to set a name on.
     43    @param name The name to be set.
    4244    @throws InvalidDataException If the name is null or is longer
    4345      than {@link Nameable#MAX_NAME_LENGTH} constant
    … …  
    5355  /**
    5456    Set the description of a {@link NameableData} object.
     57    @param nameableData A NameableData to set description on.
     58    @param description The description to be set.
    5559    @throws InvalidDataException If the description is longer
    5660      than {@link Nameable#MAX_DESCRIPTION_LENGTH} constant

  • trunk/src/core/net/sf/basedb/core/Operator.java

    r3775 r4040  
    168168  /**
    169169    Get the integer value that is used when storing an operator in the database.
     170    @return an Integer
    170171  */
    171172  public int getValue()
    … …  
    176177  /**
    177178    Get the symbol for this operator, useful for display in client applications.
     179    @return a String object
    178180  */
    179181  public String getSymbol()
    … …  
    185187    Get the SQL symbol for this operator. This can be used when creating
    186188    SQL/HQL queries.
     189    @return A String object
    187190  */
    188191  public String getSqlSymbol()
    … …  
    201204  /**
    202205    Get the <code>Operator</code> object when you know the integer code.
     206    @param value The integer code
     207    @return an Operator object.
    203208  */
    204209  public static Operator fromValue(int value)

  • trunk/src/core/net/sf/basedb/core/OwnableUtil.java

    r3679 r4040  
    4141  /**
    4242    Set the owner of a {@link OwnableData} object.
     43    @param ownableData Data object to set owner on.
     44    @param owner User to be set as an owner.
    4345    @throws InvalidDataException If the owner is null
    4446  */

  • trunk/src/core/net/sf/basedb/core/ParameterType.java

    r3789 r4040  
    229229  /**
    230230    Check if a list of values contain invalid values.
     231    @param name The name of the parameter, used for better exception messages. 
    231232    @param values A list of objects to check
    232233    @throws InvalidDataException If the list contains too many values as

  • trunk/src/core/net/sf/basedb/core/Plate.java

    r4020 r4040  
    371371    of source plates used by the plate mapping. If the plate is not a parent, -1
    372372    is returned.
     373    @param parent The plate to get source index of, if it's a parent. Null is not allowed.
    373374    @return The source index or -1 if the plate is not a parent plate
    374375    @throws InvalidDataException If the parent is null

  • trunk/src/core/net/sf/basedb/core/PlatformVariant.java

    r4020 r4040  
    433433    already been registered this method does nothing.
    434434    @param type The file type
     435    @param required TRUE if this file type should be required by the platform, FALSE otherwise.
    435436    @throws PermissionDeniedException If the logged in user doesn't
    436437      have write permission to the platform

  • trunk/src/core/net/sf/basedb/core/PluginConfiguration.java

    r4020 r4040  
    7272    @param dc The <code>DbControl</code> which will be used for
    7373      permission checking and database access.
    74     @return The new <code>PluginDefinition</code> item
     74    @param pd PluginDefinition to create a configuration for.
     75    @return The new <code>PluginConfiguration</code> item
    7576    @throws InvalidDataException If the plugin definition is null
    7677    @throws PermissionDeniedException If the logged in user doesn't have

  • trunk/src/core/net/sf/basedb/core/PluginDefinition.java

    r4020 r4040  
    10701070  /**
    10711071    Get an instance of the plugin implementation.
     1072    @param <P> The kind of returned object that extends Plugin.
    10721073    @param clazz The class of the plugin which must be a subclass of <code>Plugin</code>
    10731074    @param jarPath Overrides the default JAR path for a plugin, null to use the default

  • trunk/src/core/net/sf/basedb/core/PluginResponse.java

    r3679 r4040  
    133133 
    134134  /**
    135     SAve all parameters that has been configured during the configuration sequence to
     135    aAve all parameters that has been configured during the configuration sequence to
    136136    the database.
     137    @param dc An open DbControl to use when accessing the database.
    137138  */
    138139  public void saveParameters(DbControl dc)

  • trunk/src/core/net/sf/basedb/core/Type.java

    r4023 r4040  
    277277  /**
    278278    Get the integer value that is used when storing a type in the database.
     279    @return an int.
    279280  */
    280281  public int getValue()
    … …  
    285286  /**
    286287    Get the class of objects that can be used as values for this type.
     288    @return a Class 
    287289    @see #isCorrectType(Object)
    288290  */
    … …  
    294296  /**
    295297    Get the string value representation of this type.
     298    @return a java.lang.String
    296299  */
    297300  public String getStringValue()
    … …  
    315318    to choose from. For example, the <code>BOOLEAN</code> and <code>TEXT</code>
    316319    type can't be enumerated.
     320    @return TRUE if it does, FALSE otherwise.
    317321  */
    318322  public boolean canEnumerate()
    … …  
    332336  /**
    333337    Check if an object is a value of the correct type. Null is allowed.
     338    @param value Value object to be checked.
    334339    @throws InvalidDataException If the value isn't of the correct type
    335340  */
    … …  
    345350  /**
    346351    Check if a list of values contain only objects of the correct type.
     352    @param values List of objects to be checked.
    347353    @throws InvalidDataException If the list contains one or more nulls or
    348354      values of incorrect object type
    … …  
    366372  /**
    367373    Check if the value is an object of the correct type.
     374    @param value Value object to be checked.
     375    @return TRUE if it is of correct type, FALSE otherwise.
    368376  */
    369377  public boolean isCorrectType(Object value)
    … …  
    380388  /**
    381389    Get the size in bytes an object of this type requires when
    382     stored in the database. If the value if null, 0 is returned,
     390    stored in the database. If the value is null, 0 is returned,
    383391    otherwise the actual value is only used if it
    384392    affects the size, ie. it is a string.
    385393    @param value The value to get the size of
     394    @return an integer
    386395  */
    387396  public abstract int sizeOf(Object value);
    … …  
    391400    returns null. Each numeric type overrides this method to create a number of
    392401    the correct type.
     402    @param num The number to convert.
     403    @return Null if this method not have been overridden.
    393404    @since 2.2
    394405  */
    … …  
    439450    @param nullIfException TRUE to return null for unparsable numeric values, or
    440451      FALSE to throw an exception
     452    @return a java.lang.Object, or null.
    441453    @throws NumberFormatException If the type is numerical and the string can't be
    442454      parsed as a number and the nullIfException parameter is false
    … …  
    492504    Parse an array of strings and try to convert them to values
    493505    of the correct object type.
     506    @param values An array of values to parse through.
    494507    @return An array of objects, or null of the array is null
    495508    @throws InvalidDataException If at least one of the strings could not
    … …  
    510523  /**
    511524    Get the <code>Type</code> object when you know the integer code.
     525    @param value The integer code to get the Type object for.
     526    @return a net.sf.basedb.core.Type object
    512527  */
    513528  public static Type fromValue(int value)
    … …  
    519534  /**
    520535    Get the <code>Type</code> object when you know the string value.
     536    @param value The string value to get the Type object for.
     537    @return a net.sf.basedb.core.Type object.
    521538  */
    522539  public static Type fromValue(String value)

  • trunk/src/core/net/sf/basedb/util/NestedIterator.java

    r3675 r4040  
    5656  /**
    5757    Create a new <code>ArrayIterator</code> object.
     58    @param collections An array of Collection objects.
    5859  */
    5960  public NestedIterator(Collection<? extends E>... collections)

  • trunk/src/core/net/sf/basedb/util/XMLUtil.java

    r4023 r4040  
    8888    @param rootElement The name of the root element tag
    8989    @param systemId The system id in the DOCTYPE section
     90    @return a {@link org.jdom.Document} object 
    9091  */
    9192  public static Document createDom(String rootElement, String systemId)
    … …  
    185186    @param attribute The name of the attribute
    186187    @param defaultValue The default value to return
     188    @return an integer.
    187189  */
    188190  public static int getIntAttribute(Element el, String attribute, int defaultValue)
    … …  
    208210    @param attribute The name of the attribute
    209211    @param defaultValue The default value to return
     212    @return TRUE if the attribute has a true value, FALSE if it has a false value
    210213  */
    211214  public static boolean getBooleanAttribute(Element el, String attribute, boolean defaultValue)

  • trunk/src/core/net/sf/basedb/util/jep/NotInReporterListFunction.java

    r3675 r4040  
    6464    to dynamically evaluate expressions. It should only be used for converting
    6565    JEP formulas to {@link Restriction}:s.
     66    @param dc Open DbControl to use when accessing database and checking permissions.
    6667    @see Jep#formulaToRestriction(String, JepFunction[]) 
    6768  */

  • trunk/src/plugins/core/net/sf/basedb/plugins/MedianRatioNormalization.java

    r3887 r4040  
    307307      median calculation
    308308    @param blockGroupSize
     309    @param progress Progress reporter for the caller to keep track of the plugin's progress. Null is allowed.
    309310    @return The normalized bioassayset
    310311    @since 2.5
Note: See TracChangeset for help on using the changeset viewer.