Skip to content

Commit

Permalink
javadocs. fixes for java8
Browse files Browse the repository at this point in the history
  • Loading branch information
Luigi R. Viggiano committed May 28, 2014
1 parent 1858af2 commit fbe3ff7
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 4 deletions.
12 changes: 9 additions & 3 deletions owner/src/main/java/org/aeonbits/owner/Config.java
Original file line number Diff line number Diff line change
Expand Up @@ -180,19 +180,23 @@ Properties load(List<URL> urls, LoadersManager loaders) {
/**
* The interval, expressed in seconds (by default), to perform checks on the filesystem to identify modified
* files and eventually perform the reloading of the properties. By default is 5 seconds.
*
* @return the hot reload value; default is 5.
*/
long value() default 5;

/**
* The time unit for the interval. By default it is {@link TimeUnit#SECONDS}.
* <p>&nbsp;</p>
* Date resolution vary from filesystem to filesystem.<br></br>
* For instance, for Ext3, ReiserFS and HSF+ the date resolution is of 1 second.<br></br>
* For FAT32 the date resolution for the last modified time is 2 seconds. <br></br>
* Date resolution vary from filesystem to filesystem.<br>
* For instance, for Ext3, ReiserFS and HSF+ the date resolution is of 1 second.<br>
* For FAT32 the date resolution for the last modified time is 2 seconds. <br>
* For Ext4 the date resolution is in nanoseconds.
* <p>&nbsp;</p>
* So, it is a good idea to express the time unit in seconds or more, since higher time resolution
* will probably not be supported by the underlying filesystem.
*
* @return the time unit; default is SECONDS.
*/
TimeUnit unit() default SECONDS;

Expand All @@ -206,6 +210,8 @@ Properties load(List<URL> urls, LoadersManager loaders) {
* <p>
* {@link HotReloadType#ASYNC}: the configuration file is checked by a background thread despite the fact that
* the config object is used or not.
*
* @return the hot reload type; default is SYNC.
*/
HotReloadType type() default SYNC;
}
Expand Down
1 change: 1 addition & 0 deletions owner/src/main/java/org/aeonbits/owner/ConfigCache.java
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ public static void clear() {
* <p>The cache will not contain the instance for the specified key once the
* call returns.
*
* @param <T> type of the interface.
* @param key key whose instance is to be removed from the cache.
* @return the previous instance associated with <tt>key</tt>, or
* <tt>null</tt> if there was no instance for <tt>key</tt>.
Expand Down
2 changes: 1 addition & 1 deletion owner/src/main/java/org/aeonbits/owner/Mutable.java
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ public interface Mutable extends Config {
/**
* Removes a {@link PropertyChangeListener} from the Mutable interface.
*
* @param listener
* @param listener the property change listener to be removed
*/
void removePropertyChangeListener(PropertyChangeListener listener);

Expand Down
1 change: 1 addition & 0 deletions owner/src/main/java/org/aeonbits/owner/StrSubstitutor.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
* can be called passing in the source text for interpolation. In the returned text all variable references (as long as
* their values are known) will be resolved. The following example demonstrates this:
* <p>&nbsp;</p>
* <pre>
* Map valuesMap = new HashMap();
* valuesMap.put(&quot;animal&quot;, &quot;quick brown fox&quot;);
* valuesMap.put(&quot;target&quot;, &quot;lazy dog&quot;);
Expand Down
1 change: 1 addition & 0 deletions owner/src/main/java/org/aeonbits/owner/loaders/Loader.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ public interface Loader extends Serializable {
* @since 1.0.5
* @param result the resulting properties where to load the {@link InputStream input}
* @param input the {@link InputStream} from where to load the properties.
* @throws java.io.IOException if there is some I/O error during the load.
*/
void load(Properties result, InputStream input) throws IOException;

Expand Down

0 comments on commit fbe3ff7

Please sign in to comment.