diff --git a/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/JacksonParser.java b/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/JacksonParser.java index 361db5273ce..b9f7e43aec9 100644 --- a/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/JacksonParser.java +++ b/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/JacksonParser.java @@ -21,6 +21,8 @@ import java.util.Map; import com.fasterxml.jackson.databind.ObjectMapper; /** + * Thin wrapper for Jackson 2 {@link ObjectMapper}. + * * @author Dave Syer * */ diff --git a/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/SimpleJsonParser.java b/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/SimpleJsonParser.java index 91d46e67c20..54dae28eab2 100644 --- a/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/SimpleJsonParser.java +++ b/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/SimpleJsonParser.java @@ -25,11 +25,24 @@ import org.springframework.util.ClassUtils; import org.springframework.util.StringUtils; /** + * Really basic JSON parser for when you have nothing else available. Comes with some + * limitations with respect to the JSON specification (e.g. only supports String values), + * so users will probably prefer to have a library handle things instead (Jackson or Snake + * YAML are supported). + * + * @see #instance() + * * @author Dave Syer * */ public class SimpleJsonParser implements JsonParser { + /** + * Static factory for the "best" JSON parser available on the classpath. Tries Jackson + * (2), then Snake YAML, and then falls back to the {@link SimpleJsonParser}. + * + * @return a {@link JsonParser} + */ public static JsonParser instance() { if (ClassUtils.isPresent("org.yaml.snakeyaml.Yaml", null)) { return new YamlParser(); diff --git a/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/YamlParser.java b/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/YamlParser.java index 6c1f2eed06e..58e67403684 100644 --- a/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/YamlParser.java +++ b/spring-bootstrap/src/main/java/org/springframework/bootstrap/config/YamlParser.java @@ -21,6 +21,8 @@ import java.util.Map; import org.yaml.snakeyaml.Yaml; /** + * Thin wrapper for Snake {@link Yaml}. + * * @author Dave Syer * */