Changeset 7456


Ignore:
Timestamp:
Mar 6, 2018, 5:15:04 PM (4 years ago)
Author:
Nicklas Nordborg
Message:

Fixes javadoc errors and warnings before release.

Location:
branches/3.12-stable/src/core/net/sf/basedb
Files:
19 edited

Legend:

Unmodified
Added
Removed
  • branches/3.12-stable/src/core/net/sf/basedb/core/AbstractHqlQuery.java

    r7381 r7456  
    4646  class can be used to build and manage just about any type of HQL
    4747  query. It has no function for executing the query or returning
    48   the result. Subclasses may use {@link #getMainHqlQuery(DbControl)}
     48  the result. Subclasses may use {@link #getMainHqlQuery(DbControl, Class)}
    4949  to generate a Hibernate Query object that is ready to be executed.
    5050
  • branches/3.12-stable/src/core/net/sf/basedb/core/Annotation.java

    r7381 r7456  
    745745    <p>
    746746    An exception to the above (since BASE 3.11) is if the annotation was loaded with
    747     {@link AnnotationSet#getProjectAnnotation(AnnotationType, int)} in
     747    {@link AnnotationSet#getProjectAnnotation(AnnotationType, Project)} in
    748748    which case currently active project is ignored and the values are
    749749    always changed on this annotation (eg. the same as if this annotation
  • branches/3.12-stable/src/core/net/sf/basedb/core/AnnotationBetweenRestriction.java

    r7381 r7456  
    7070  /**
    7171    @since 3.5
    72     @deprecated In 3.11, use {@link #AnnotationBetweenRestriction(String, AnnotationType, Object, Object, Options)} instead
     72    @deprecated In 3.11, use {@link #AnnotationBetweenRestriction(String, AnnotationType, Object, Object, AnnotationRestriction.Options)} instead
    7373  */
    7474  @Deprecated
     
    8383  /**
    8484    @since 3.5
    85     @deprecated In 3.11, use {@link #AnnotationBetweenRestriction(String, AnnotationType, Object, Object, Options)} instead
     85    @deprecated In 3.11, use {@link #AnnotationBetweenRestriction(String, AnnotationType, Object, Object, AnnotationRestriction.Options)} instead
    8686  */
    8787  @Deprecated
  • branches/3.12-stable/src/core/net/sf/basedb/core/AnnotationInRestriction.java

    r7381 r7456  
    5858  /**
    5959    @since 3.5
    60     @deprecated In 3.11, use {@link #AnnotationInRestriction(String, AnnotationType, Options, Object...)} instead
     60    @deprecated In 3.11, use {@link #AnnotationInRestriction(String, AnnotationType, AnnotationRestriction.Options, Object...)} instead
    6161  */
    6262  @Deprecated
  • branches/3.12-stable/src/core/net/sf/basedb/core/AnnotationRestriction.java

    r7381 r7456  
    3939  Base class for creating restrictions based on annotations.
    4040  Subclasses must implent the {@link #getRestrictionSql(Query, DbControl)}
    41   and {@link #setRestrictionParameters(SQLQuery)}
     41  and {@link #setRestrictionParameters(NativeQuery)}
    4242  method.
    4343 
     
    316316    @param query The query object we are about to execute
    317317    @return An SQL fragment, or null if no additional restriction is required
    318     @see #setRestrictionParameters(SQLQuery)
     318    @see #setRestrictionParameters(NativeQuery)
    319319  */
    320320  abstract String getRestrictionSql(Query query, DbControl dc)
  • branches/3.12-stable/src/core/net/sf/basedb/core/AnnotationSimpleRestriction.java

    r7381 r7456  
    6464  /**
    6565    @since 3.5
    66     @deprecated In 3.11, use {@link #AnnotationSimpleRestriction(String, AnnotationType, Operator, Object, Options)} instead
     66    @deprecated In 3.11, use {@link #AnnotationSimpleRestriction(String, AnnotationType, Operator, Object, AnnotationRestriction.Options)} instead
    6767  */
    6868  @Deprecated
     
    125125  /**
    126126    @since 3.5
    127     @deprecated In 3.11, use {@link #AnnotationSimpleRestriction(String, AnnotationType, Operator, Object, Options)} instead
     127    @deprecated In 3.11, use {@link #AnnotationSimpleRestriction(String, AnnotationType, Operator, Object, AnnotationRestriction.Options)} instead
    128128  */
    129129  @Deprecated
     
    163163  /**
    164164    @since 3.5
    165     @deprecated In 3.11, use {@link #AnnotationSimpleRestriction(String, AnnotationType, Operator, List, Options)} instead
     165    @deprecated In 3.11, use {@link #AnnotationSimpleRestriction(String, AnnotationType, Operator, Object, AnnotationRestriction.Options)} instead
    166166  */
    167167  @Deprecated
  • branches/3.12-stable/src/core/net/sf/basedb/core/HasAnnotationRestriction.java

    r7381 r7456  
    7676      by the query or not
    7777    @since 3.5
    78     @deprecated In 3.11, use {@link #HasAnnotationRestriction(String, AnnotationType, boolean, Options)} instead
     78    @deprecated In 3.11, use {@link #HasAnnotationRestriction(String, AnnotationType, boolean, AnnotationRestriction.Options)} instead
    7979  */
    8080  @Deprecated
     
    106106 
    107107  /**
    108     @see #HasAnnotationRestriction(String, AnnotationType, boolean, boolean, boolean)
     108    @see #HasAnnotationRestriction(String, AnnotationType, boolean, AnnotationRestriction.Options)
    109109    @since 3.5
    110     @deprecated In 3.11, use {@link #HasAnnotationRestriction(String, AnnotationType, boolean, Options)} instead
     110    @deprecated In 3.11, use {@link #HasAnnotationRestriction(String, AnnotationType, boolean, AnnotationRestriction.Options)} instead
    111111  */
    112112  @Deprecated
  • branches/3.12-stable/src/core/net/sf/basedb/core/HibernateUtil.java

    r7416 r7456  
    20472047    using a query.
    20482048   
    2049     @param clazz The list should contain objects of this class
    20502049    @param query The query to execute
    20512050    @param sc A optional SessionControl that is automatically protected from
     
    20742073  /**
    20752074    Scroll through the result of a query using an iterator.
    2076     @param clazz The iterator returns objects of this class
    20772075    @param query The query to execute
    20782076    @param sc A optional SessionControl that is automatically protected from
  • branches/3.12-stable/src/core/net/sf/basedb/core/Job.java

    r7381 r7456  
    11171117 
    11181118  /**
    1119     @see {@link #start(String, String, String, JobAgent, Date)}
     1119    @see #start(String, String, String, JobAgent, Date)
    11201120    @since 3.3
    11211121  */
     
    15171517 
    15181518  /**
    1519     @see {@link #execute(ProgressReporter, String, String, JobAgentSettings)}
     1519    @see #execute(ProgressReporter, String, String, JobAgentSettings)
    15201520  */
    15211521  public PluginExecutionRequest execute(ProgressReporter progress, String server, JobAgentSettings settings)
  • branches/3.12-stable/src/core/net/sf/basedb/core/QueryExecutor.java

    r7381 r7456  
    112112  /**
    113113    Executes a Hibernate query that returns an iterator on a stateless session.
    114     @param clazz The class of items returned by the iterator
    115114    @param query The query to execute
    116115    @param session The stateless session, this must be the same session
  • branches/3.12-stable/src/core/net/sf/basedb/core/Update.java

    r7413 r7456  
    5858import net.sf.basedb.core.data.KitData;
    5959import net.sf.basedb.core.data.MeasuredBioMaterialData;
     60import net.sf.basedb.core.data.NewsData;
    6061import net.sf.basedb.core.data.ParameterValueData;
    6162import net.sf.basedb.core.data.PropertyFilterData;
  • branches/3.12-stable/src/core/net/sf/basedb/core/User.java

    r7452 r7456  
    599599    enable this feature by itself, the email address must first
    600600    be verified.
    601     @see #sendEmailVerificationCode()
     601    @see #sendEmailVerificationCode(String)
    602602    @see #enableDeviceVerification(String)
    603603    @since 3.12
     
    616616    Send a verification code to the currently registered email address.
    617617    The client application should ask the user to enter the verification
    618     code and then call {@link #verifyEmail(String)}. The verification must
     618    code and then call {@link #enableDeviceVerification(String)}. The verification must
    619619    be done with the same User instance since the verification code
    620620    is only temporarily stored inside this instance.
     
    666666    Verify the email and enables device verification.
    667667    @param code The code that was sent by email to the user
    668     @see #sendEmailVerificationCode()
     668    @see #sendEmailVerificationCode(String)
    669669    @since 3.12
    670670  */
  • branches/3.12-stable/src/core/net/sf/basedb/core/data/UserDeviceData.java

    r7414 r7456  
    172172  /**
    173173    The maximum length of the remote ID that can be stored in the database.
    174     @see #setRemoteId(String)
     174    @see #setLastRemoteId(String)
    175175  */
    176176  public static final int MAX_REMOTE_ID_LENGTH = 255;
  • branches/3.12-stable/src/core/net/sf/basedb/util/HttpUtil.java

    r7411 r7456  
    139139    Parse the User-Agent string from a HTTP request and return
    140140    information about what it actually means.
    141     @see https://github.com/nielsbasjes/yauaa
     141    @see <a href="https://github.com/nielsbasjes/yauaa">https://github.com/nielsbasjes/yauaa</a>
    142142    @since 3.12
    143143  */
  • branches/3.12-stable/src/core/net/sf/basedb/util/ProgressInputStream.java

    r7168 r7456  
    8181  /**
    8282    Send a progress report with the given message. This method is called
    83     autoamtically at the given intervals. The default message is the number
     83    automatically at the given intervals. The default message is the number
    8484    of bytes read so far (formatted as a string with
    8585    {@link Values#formatBytes(Long, int)}). Subclasses may override this
    8686    method to generate a different message.
    87    
    88     @param message
    8987  */
    9088  protected void progressReport(String message)
  • branches/3.12-stable/src/core/net/sf/basedb/util/extensions/ActionIterator.java

    r7275 r7456  
    173173  /**
    174174    Send the event to event handlers registered in the registry.
    175     @see Registry#handleEvent(EventType, ExtensionPoint, Extension)}
     175    @see Registry#handleEvent(EventType, ExtensionPoint, Extension)
    176176    @since 3.10
    177177  */
  • branches/3.12-stable/src/core/net/sf/basedb/util/extensions/manager/processor/IgnoreFileProcessor.java

    r7233 r7456  
    100100    it happend when the {@link #done(ExtensionsManager)} method is
    101101    called by the manager. If this flag is set the
    102     {@link #finalizeRegistration(ExtensionsManager, boolean)}
     102    {@link #finalizeRegistration(ExtensionsManager)}
    103103    method must be explicitely called.
    104104  */
  • branches/3.12-stable/src/core/net/sf/basedb/util/overview/loader/BasicItemNodeLoaderFactory.java

    r7004 r7456  
    123123    Register a node loader implementation. The implementation must have a
    124124    public no-argument constructor. The given class is checked with
    125     {@link ClassUtil#checkAndLoadClass(ClassLoader, String, boolean, Class...)}
     125    {@link ClassUtil#checkAndLoadClass(ClassLoader, String, boolean, Class, Class...)}
    126126   
    127127    @param key The item type the node loader handles
  • branches/3.12-stable/src/core/net/sf/basedb/util/overview/validator/BasicItemNodeValidatorFactory.java

    r7005 r7456  
    149149    Register a node validator implementation. The implementation must have a
    150150    public no-argument constructor. The given class is checked with
    151     {@link ClassUtil#checkAndLoadClass(ClassLoader, String, boolean, Class...)}
     151    {@link ClassUtil#checkAndLoadClass(ClassLoader, String, boolean, Class, Class...)}
    152152   
    153153    @param key The item type the node validator handles
Note: See TracChangeset for help on using the changeset viewer.