vmario/docs
1
0
Fork 0
mirror of https://github.com/sismics/docs.git synced 2024-11-21 21:47:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup javadoc

Browse Source
This commit is contained in:
jendib 2013-08-13 01:53:54 +02:00
parent 460fd00f7f
commit fd3597b3d1
3 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs-core/src/main/java/com/sismics/util/JsonValidationUtil.java
View File

@ -14,9 +14,9 @@ public class JsonValidationUtil {
/** /**
* Checks if the JSON node contains the properties (not null). * Checks if the JSON node contains the properties (not null).
* *
* @param s JSON node to check * @param n JSON node to check
* @param name Name of the property * @param name Name of the property
* @throws JSONException * @throws Exception
*/ */
public static void validateJsonRequired(JsonNode n, String name) throws Exception { public static void validateJsonRequired(JsonNode n, String name) throws Exception {
if (!n.has(name)) { if (!n.has(name)) {
@ -27,10 +27,10 @@ public class JsonValidationUtil {
/** /**
* Checks that the property is a JSON object. * Checks that the property is a JSON object.
* *
* @param s JSON node to check * @param n JSON node to check
* @param name Name of the property * @param name Name of the property
* @param required Property required * @param required Property required
* @throws JSONException * @throws Exception
*/ */
public static void validateJsonObject(JsonNode n, String name, boolean required) throws Exception { public static void validateJsonObject(JsonNode n, String name, boolean required) throws Exception {
if (required && !n.has(name)) { if (required && !n.has(name)) {
@ -44,10 +44,10 @@ public class JsonValidationUtil {
/** /**
* Checks that the property is a number. * Checks that the property is a number.
* *
* @param s JSON node to check * @param n JSON node to check
* @param name Name of the property * @param name Name of the property
* @param required Property required * @param required Property required
* @throws JSONException * @throws Exception
*/ */
public static void validateJsonNumber(JsonNode n, String name, boolean required) throws Exception { public static void validateJsonNumber(JsonNode n, String name, boolean required) throws Exception {
if (required && !n.has(name)) { if (required && !n.has(name)) {
@ -61,10 +61,10 @@ public class JsonValidationUtil {
/** /**
* Checks that the property is a long. * Checks that the property is a long.
* *
* @param s JSON node to check * @param n JSON node to check
* @param name Name of the property * @param name Name of the property
* @param required Property required * @param required Property required
* @throws JSONException * @throws Exception
*/ */
public static void validateJsonLong(JsonNode n, String name, boolean required) throws Exception { public static void validateJsonLong(JsonNode n, String name, boolean required) throws Exception {
if (required && !n.has(name)) { if (required && !n.has(name)) {
@ -78,10 +78,10 @@ public class JsonValidationUtil {
/** /**
* Checks that the property is a string. * Checks that the property is a string.
* *
* @param s JSON node to check * @param n JSON node to check
* @param name Name of the property * @param name Name of the property
* @param required Property required * @param required Property required
* @throws JSONException * @throws Exception
*/ */
public static void validateJsonString(JsonNode n, String name, boolean required) throws Exception { public static void validateJsonString(JsonNode n, String name, boolean required) throws Exception {
if (required && !n.has(name)) { if (required && !n.has(name)) {
@ -95,10 +95,10 @@ public class JsonValidationUtil {
/** /**
* Checks that the property is an array. * Checks that the property is an array.
* *
* @param s JSON node to check * @param n JSON node to check
* @param name Name of the property * @param name Name of the property
* @param required Property required * @param required Property required
* @throws JSONException * @throws Exception
*/ */
public static void validateJsonArray(JsonNode n, String name, boolean required) throws Exception { public static void validateJsonArray(JsonNode n, String name, boolean required) throws Exception {
if (required && !n.has(name)) { if (required && !n.has(name)) {

2
docs-core/src/main/java/com/sismics/util/LocaleUtil.java
View File

@ -36,7 +36,7 @@ public class LocaleUtil {
/** /**
* Extracts the ID of the locale from the HTTP Accept-Language header. * Extracts the ID of the locale from the HTTP Accept-Language header.
* *
* @param HTTP header * @param acceptLanguageHeader header
* @return Locale ID * @return Locale ID
*/ */
public static String getLocaleIdFromAcceptLanguage(String acceptLanguageHeader) { public static String getLocaleIdFromAcceptLanguage(String acceptLanguageHeader) {

2
docs-core/src/main/java/com/sismics/util/mime/MimeTypeUtil.java
View File

@ -11,7 +11,7 @@ public class MimeTypeUtil {
/** /**
* Try to guess the MIME type of a file by its magic number (header). * Try to guess the MIME type of a file by its magic number (header).
* *
* @param file File to inspect * @param is Stream to inspect
* @return MIME type * @return MIME type
* @throws Exception * @throws Exception
*/ */