improved javadoc
authorchrislovsund@netbeans.org
Wed, 27 Mar 2013 18:00:25 +0100
changeset 367fffd72497d67
parent 366 ce9f6b41f737
child 368 4fdbdb29305e
improved javadoc
EADS-3568 - When deploying files to secondary DB the notification dialog only shows about every other time
PLSQL/Utilities/src/org/netbeans/modules/plsql/utilities/PlsqlFileValidatorService.java
     1.1 --- a/PLSQL/Utilities/src/org/netbeans/modules/plsql/utilities/PlsqlFileValidatorService.java	Wed Mar 27 17:59:57 2013 +0100
     1.2 +++ b/PLSQL/Utilities/src/org/netbeans/modules/plsql/utilities/PlsqlFileValidatorService.java	Wed Mar 27 18:00:25 2013 +0100
     1.3 @@ -50,76 +50,94 @@
     1.4   */
     1.5  public interface PlsqlFileValidatorService {
     1.6  
     1.7 -   /**
     1.8 -    * Check if DataObject is valid (based on extension).
     1.9 -    * If null object sent false is returned.
    1.10 -    * @param dataObject 
    1.11 -    * @return true if valid
    1.12 -    */
    1.13 -   public boolean isValidPackage(DataObject dataObject);
    1.14 +    /**
    1.15 +     * Check if DataObject is valid (based on extension). If null object sent false is returned.
    1.16 +     *
    1.17 +     * @param dataObject
    1.18 +     * @return true if valid
    1.19 +     */
    1.20 +    public boolean isValidPackage(DataObject dataObject);
    1.21  
    1.22 -   /**
    1.23 -    * Check if FileObject is valid (based on extension).
    1.24 -    * If null object sent false is returned.
    1.25 -    * @param fileObject
    1.26 -    * @return true if valid
    1.27 -    */
    1.28 -   public boolean isValidPackage(FileObject fileObject);
    1.29 +    /**
    1.30 +     * Check if FileObject is valid (based on extension). If null object sent false is returned.
    1.31 +     *
    1.32 +     * @param fileObject
    1.33 +     * @return true if valid
    1.34 +     */
    1.35 +    public boolean isValidPackage(FileObject fileObject);
    1.36  
    1.37 -   /**
    1.38 -    * Check if DataObject is valid spec file (based on extension).
    1.39 -    * If null object sent false is returned.
    1.40 -    * @param dataObject
    1.41 -    * @return
    1.42 -    */
    1.43 -   public boolean isValidPackageSpec(DataObject dataObject);
    1.44 +    /**
    1.45 +     * Check if DataObject is valid spec file (based on extension). If null object sent false is returned.
    1.46 +     *
    1.47 +     * @param dataObject
    1.48 +     * @return true if DataObject is valid spec file (based on extension)
    1.49 +     */
    1.50 +    public boolean isValidPackageSpec(DataObject dataObject);
    1.51  
    1.52 -   public boolean isValidPackageSpec(String fileExt);
    1.53 +    /**
    1.54 +     * Check if file extension is valid spec extension. If null object sent false is returned.
    1.55 +     *
    1.56 +     * @param fileExt
    1.57 +     * @return true if file extension is valid spec extension. false if null object sent.
    1.58 +     */
    1.59 +    public boolean isValidPackageSpec(String fileExt);
    1.60  
    1.61 -   /**
    1.62 -    * Check if DataObject is valid body file (based on extension).
    1.63 -    * If null object sent false is returned.
    1.64 -    * @param dataObject
    1.65 -    * @return
    1.66 -    */
    1.67 -   public boolean isValidPackageBody(DataObject dataObject);
    1.68 +    /**
    1.69 +     * Check if DataObject is valid body file (based on extension). If null object sent false is returned.
    1.70 +     *
    1.71 +     * @param dataObject
    1.72 +     * @return
    1.73 +     */
    1.74 +    public boolean isValidPackageBody(DataObject dataObject);
    1.75  
    1.76 -   public boolean isValidPackageBody(String fileExt);
    1.77 +    /**
    1.78 +     *
    1.79 +     * @param fileExt
    1.80 +     * @return
    1.81 +     */
    1.82 +    public boolean isValidPackageBody(String fileExt);
    1.83  
    1.84 -   /**
    1.85 -    * Check if DataObject is valid .tdb file.
    1.86 -    * If null object sent false is returned.
    1.87 -    * @param dataObject
    1.88 -    * @return
    1.89 -    */
    1.90 -   public boolean isValidTDB(DataObject dataObject);
    1.91 +    /**
    1.92 +     * Check if DataObject is valid .tdb file. If null object sent false is returned.
    1.93 +     *
    1.94 +     * @param dataObject
    1.95 +     * @return
    1.96 +     */
    1.97 +    public boolean isValidTDB(DataObject dataObject);
    1.98  
    1.99 -   /**
   1.100 -    * Returns valid DataObject or null if sourceDataObject has no sibling 
   1.101 -    * or sibling is not Valid (not found).
   1.102 -    * @param sourceDataObject
   1.103 -    * @return
   1.104 -    */
   1.105 -   public DataObject getSiblingExt(DataObject sourceDataObject);
   1.106 +    /**
   1.107 +     * Returns valid DataObject or null if sourceDataObject has no sibling or sibling is not Valid (not found).
   1.108 +     *
   1.109 +     * @param sourceDataObject
   1.110 +     * @return
   1.111 +     */
   1.112 +    public DataObject getSiblingExt(DataObject sourceDataObject);
   1.113  
   1.114 -   /**
   1.115 -    * Get file extension for given sibling.
   1.116 -    * @param siblingExt case extension
   1.117 -    * @return sibling extension if found or null if not found.
   1.118 -    */
   1.119 -   public String getSiblingExt(String siblingExt);
   1.120 +    /**
   1.121 +     * Get file extension for given sibling.
   1.122 +     *
   1.123 +     * @param siblingExt case extension
   1.124 +     * @return sibling extension if found or null if not found.
   1.125 +     */
   1.126 +    public String getSiblingExt(String siblingExt);
   1.127  
   1.128 -   /**
   1.129 -    * 
   1.130 -    * @return
   1.131 -    */
   1.132 -   public String getDefaultPackageBodyExt();
   1.133 +    /**
   1.134 +     *
   1.135 +     * @return file extension for body package.
   1.136 +     */
   1.137 +    public String getDefaultPackageBodyExt();
   1.138  
   1.139 -   /**
   1.140 -    * 
   1.141 -    * @return
   1.142 -    */
   1.143 -   public String getDefaultPackageSpecExt();
   1.144 +    /**
   1.145 +     *
   1.146 +     * @return file extension for spec package.
   1.147 +     */
   1.148 +    public String getDefaultPackageSpecExt();
   1.149  
   1.150 -   public boolean isValidPackageDefault(DataObject dataObject);
   1.151 +    /**
   1.152 +     * Check if DataObject is valid default package file (based on extension). If null object sent false is returned.
   1.153 +     *
   1.154 +     * @param dataObject
   1.155 +     * @return true if DataObject is valid default package file (based on extension).
   1.156 +     */
   1.157 +    public boolean isValidPackageDefault(DataObject dataObject);
   1.158  }