SGF-402 - Document Lucene integration support.

This commit is contained in:
John Blum
2017-03-29 12:06:28 -07:00
parent 9f0a07273c
commit 556afed877
9 changed files with 365 additions and 70 deletions

View File

@@ -35,10 +35,10 @@ public abstract class RuntimeExceptionFactory {
/**
* Constructs and initializes an {@link IllegalArgumentException} with the given {@link String message}
* and {@link Object[] arguments} used to format the message.
* and {@link Object arguments} used to format the message.
*
* @param message {@link String} describing the {@link IllegalArgumentException exception}.
* @param args {@link Object[] arguments} used to replace format placeholders in the {@link String message}.
* @param args {@link Object arguments} used to replace format placeholders in the {@link String message}.
* @return a new {@link IllegalArgumentException} with the given {@link String message}.
* @see #newIllegalArgumentException(Throwable, String, Object...)
* @see java.lang.IllegalArgumentException
@@ -49,11 +49,11 @@ public abstract class RuntimeExceptionFactory {
/**
* Constructs and initializes an {@link IllegalArgumentException} with the given {@link Throwable cause},
* {@link String message} and {@link Object[] arguments} used to format the message.
* {@link String message} and {@link Object arguments} used to format the message.
*
* @param cause {@link Throwable} identifying the reason the {@link IllegalArgumentException} was thrown.
* @param message {@link String} describing the {@link IllegalArgumentException exception}.
* @param args {@link Object[] arguments} used to replace format placeholders in the {@link String message}.
* @param args {@link Object arguments} used to replace format placeholders in the {@link String message}.
* @return a new {@link IllegalArgumentException} with the given {@link Throwable cause} and {@link String message}.
* @see java.lang.IllegalArgumentException
*/
@@ -65,10 +65,10 @@ public abstract class RuntimeExceptionFactory {
/**
* Constructs and initializes an {@link IllegalStateException} with the given {@link String message}
* and {@link Object[] arguments} used to format the message.
* and {@link Object arguments} used to format the message.
*
* @param message {@link String} describing the {@link IllegalStateException exception}.
* @param args {@link Object[] arguments} used to replace format placeholders in the {@link String message}.
* @param args {@link Object arguments} used to replace format placeholders in the {@link String message}.
* @return a new {@link IllegalStateException} with the given {@link String message}.
* @see #newIllegalStateException(Throwable, String, Object...)
* @see java.lang.IllegalStateException
@@ -79,11 +79,11 @@ public abstract class RuntimeExceptionFactory {
/**
* Constructs and initializes an {@link IllegalStateException} with the given {@link Throwable cause},
* {@link String message} and {@link Object[] arguments} used to format the message.
* {@link String message} and {@link Object arguments} used to format the message.
*
* @param cause {@link Throwable} identifying the reason the {@link IllegalStateException} was thrown.
* @param message {@link String} describing the {@link IllegalStateException exception}.
* @param args {@link Object[] arguments} used to replace format placeholders in the {@link String message}.
* @param args {@link Object arguments} used to replace format placeholders in the {@link String message}.
* @return a new {@link IllegalStateException} with the given {@link Throwable cause} and {@link String message}.
* @see java.lang.IllegalStateException
*/
@@ -93,10 +93,10 @@ public abstract class RuntimeExceptionFactory {
/**
* Constructs and initializes an {@link RuntimeException} with the given {@link String message}
* and {@link Object[] arguments} used to format the message.
* and {@link Object arguments} used to format the message.
*
* @param message {@link String} describing the {@link RuntimeException exception}.
* @param args {@link Object[] arguments} used to replace format placeholders in the {@link String message}.
* @param args {@link Object arguments} used to replace format placeholders in the {@link String message}.
* @return a new {@link RuntimeException} with the given {@link String message}.
* @see #newRuntimeException(Throwable, String, Object...)
* @see java.lang.RuntimeException
@@ -107,11 +107,11 @@ public abstract class RuntimeExceptionFactory {
/**
* Constructs and initializes an {@link RuntimeException} with the given {@link Throwable cause},
* {@link String message} and {@link Object[] arguments} used to format the message.
* {@link String message} and {@link Object arguments} used to format the message.
*
* @param cause {@link Throwable} identifying the reason the {@link RuntimeException} was thrown.
* @param message {@link String} describing the {@link RuntimeException exception}.
* @param args {@link Object[] arguments} used to replace format placeholders in the {@link String message}.
* @param args {@link Object arguments} used to replace format placeholders in the {@link String message}.
* @return a new {@link RuntimeException} with the given {@link Throwable cause} and {@link String message}.
* @see java.lang.RuntimeException
*/
@@ -121,10 +121,10 @@ public abstract class RuntimeExceptionFactory {
/**
* Constructs and initializes an {@link UnsupportedOperationException} with the given {@link String message}
* and {@link Object[] arguments} used to format the message.
* and {@link Object arguments} used to format the message.
*
* @param message {@link String} describing the {@link UnsupportedOperationException exception}.
* @param args {@link Object[] arguments} used to replace format placeholders in the {@link String message}
* @param args {@link Object arguments} used to replace format placeholders in the {@link String message}
* @return a new {@link UnsupportedOperationException} with the given {@link String message}.
* @see #newUnsupportedOperationException(Throwable, String, Object...)
* @see java.lang.UnsupportedOperationException
@@ -135,11 +135,11 @@ public abstract class RuntimeExceptionFactory {
/**
* Constructs and initializes an {@link UnsupportedOperationException} with the given {@link Throwable cause},
* {@link String message} and {@link Object[] arguments} used to format the message.
* {@link String message} and {@link Object arguments} used to format the message.
*
* @param cause {@link Throwable} identifying the reason the {@link UnsupportedOperationException} was thrown.
* @param message {@link String} describing the {@link UnsupportedOperationException exception}.
* @param args {@link Object[] arguments} used to replace format placeholders in the {@link String message}.
* @param args {@link Object arguments} used to replace format placeholders in the {@link String message}.
* @return a new {@link UnsupportedOperationException} with the given {@link Throwable cause}
* and {@link String message}.
* @see java.lang.UnsupportedOperationException
@@ -151,10 +151,10 @@ public abstract class RuntimeExceptionFactory {
}
/**
* Formats the given {@link String message} using the given {@link Object[] arguments}.
* Formats the given {@link String message} using the given {@link Object arguments}.
*
* @param message {@link String} containing the message pattern to format.
* @param args {@link Object[] arguments} used in the message to replace format placeholders.
* @param args {@link Object arguments} used in the message to replace format placeholders.
* @return the formatted {@link String message}.
* @see java.lang.String#format(String, Object...)
* @see java.text.MessageFormat#format(String, Object...)