Plexus-Mirror/toml4j
1
0
Fork 0
mirror of https://github.com/plexusorg/toml4j.git synced 2025-02-11 11:40:27 +00:00
Code Issues Projects Releases Wiki Activity

Fixed Javadoc for Java 8

Browse source
This commit is contained in:
moandji.ezana 2014-12-16 01:07:59 +02:00
parent e425f81011
commit 28c57069c6
1 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/main/java/com/moandjiezana/toml/Toml.java
View file

@ -33,13 +33,13 @@ import com.google.gson.JsonElement;
* {@link #getList(String, Class)}, {@link #getTable(String)} and {@link #getTables(String)} return empty values if there is no matching key.</p> * {@link #getList(String, Class)}, {@link #getTable(String)} and {@link #getTables(String)} return empty values if there is no matching key.</p>
* *
* <p>Example usage:</p> * <p>Example usage:</p>
* <code><pre> * <pre><code>
* Toml toml = new Toml().parse(getTomlFile()); * Toml toml = new Toml().parse(getTomlFile());
* String name = toml.getString("name"); * String name = toml.getString("name");
* Long port = toml.getLong("server.ip"); // compound key. Is equivalent to: * Long port = toml.getLong("server.ip"); // compound key. Is equivalent to:
* Long port2 = toml.getTable("server").getLong("ip"); * Long port2 = toml.getTable("server").getLong("ip");
* MyConfig config = toml.to(MyConfig.class); * MyConfig config = toml.to(MyConfig.class);
* </pre></code> * </code></pre>
* *
*/ */
public class Toml { public class Toml {
@ -67,7 +67,7 @@ public class Toml {
/** /**
* Populates the current Toml instance with values from file. * Populates the current Toml instance with values from file.
* *
* @param file * @param file The File to be read
* @return this instance * @return this instance
* @throws IllegalStateException If file contains invalid TOML * @throws IllegalStateException If file contains invalid TOML
*/ */
@ -82,7 +82,7 @@ public class Toml {
/** /**
* Populates the current Toml instance with values from inputStream. * Populates the current Toml instance with values from inputStream.
* *
* @param inputStream * @param inputStream Closed after it has been read.
* @return this instance * @return this instance
* @throws IllegalStateException If file contains invalid TOML * @throws IllegalStateException If file contains invalid TOML
*/ */
@ -93,7 +93,7 @@ public class Toml {
/** /**
* Populates the current Toml instance with values from reader. * Populates the current Toml instance with values from reader.
* *
* @param reader * @param reader Closed after it has been read.
* @return this instance * @return this instance
* @throws IllegalStateException If file contains invalid TOML * @throws IllegalStateException If file contains invalid TOML
*/ */
@ -122,7 +122,7 @@ public class Toml {
/** /**
* Populates the current Toml instance with values from tomlString. * Populates the current Toml instance with values from tomlString.
* *
* @param tomlString * @param tomlString String to be read.
* @return this instance * @return this instance
* @throws IllegalStateException If tomlString is not valid TOML * @throws IllegalStateException If tomlString is not valid TOML
*/ */
@ -169,9 +169,8 @@ public class Toml {
} }
/** /**
* If no value is found for key, an empty Toml instance is returned. * @param key A table name, not including square brackets.
* * @return A new Toml instance. Empty if no value is found for key.
* @param key
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public Toml getTable(String key) { public Toml getTable(String key) {
@ -179,8 +178,8 @@ public class Toml {
} }
/** /**
* If no value is found for key, an empty list is returned. * @param key Name of array of tables, not including square brackets.
* @param key * @return An empty List if no value is found for key.
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public List<Toml> getTables(String key) { public List<Toml> getTables(String key) {
@ -214,7 +213,9 @@ public class Toml {
* <li>TOML array to {@link Set}</li> * <li>TOML array to {@link Set}</li>
* </ul> * </ul>
* *
* @param targetClass * @param targetClass Class to deserialize TOML to.
* @param <T> type of targetClass.
* @return A new instance of targetClass.
*/ */
public <T> T to(Class<T> targetClass) { public <T> T to(Class<T> targetClass) {
return to(targetClass, DEFAULT_GSON); return to(targetClass, DEFAULT_GSON);