Ratpack fix formatting and non-ascii characters

This commit is contained in:
Jonathan Leitschuh
2021-05-11 10:58:33 -04:00
parent a3b1736a73
commit cdfdcc66bd
21 changed files with 27 additions and 26 deletions

View File

@@ -11,4 +11,5 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
*/

View File

@@ -105,4 +105,4 @@ public interface Form extends MultiValueMap<String, String> {
return null;
}
}
}

View File

@@ -34,4 +34,4 @@ public interface UploadedFile extends TypedData {
@Nullable
String getFileName();
}
}

View File

@@ -304,7 +304,7 @@ public interface Context extends Registry {
/**
* Parse the request into the given type, using no options (or more specifically an instance of {@link NullParseOpts} as the options).
* <p>
* The code sample is functionally identical to the sample given for the {@link #parse(Parse)} variant
* The code sample is functionally identical to the sample given for the {@link #parse(Parse)} variant
* <pre class="java">{@code
* import ratpack.core.handling.Handler;
* import ratpack.core.handling.Context;
@@ -469,4 +469,4 @@ public interface Context extends Registry {
clientError(404);
}
}
}

View File

@@ -27,7 +27,7 @@ import ratpack.exec.registry.Registry;
* <h3>Non blocking/Asynchronous</h3>
* <p>
* Handlers are expected to be asynchronous.
* That is, there is no expectation that the handler is “finished when its {@link #handle(Context)} method returns.
* That is, there is no expectation that the handler is “finished" when its {@link #handle(Context)} method returns.
* This facilitates the use of non blocking IO without needing to enter some kind of special mode.
* An implication is that handlers <b>must</b> ensure that they either send a response or delegate to another handler.
* </p>
@@ -125,4 +125,4 @@ public interface Handler {
*/
void handle(Context ctx) throws Exception;
}
}

View File

@@ -129,4 +129,4 @@ public interface Headers {
MultiValueMap<String, String> asMultiValueMap();
}
}

View File

@@ -126,4 +126,4 @@ public interface MediaType {
* @return True if this represents the absence of a value (i.e. no Content-Type header)
*/
boolean isEmpty();
}
}

View File

@@ -105,4 +105,4 @@ public interface MutableHeaders extends Headers {
MutableHeaders copy(Headers headers);
}
}

View File

@@ -358,4 +358,4 @@ public interface Request {
*/
long getMaxContentLength();
}
}

View File

@@ -207,4 +207,4 @@ public interface Response {
default Response forceCloseConnection() {
return null;
}
}
}

View File

@@ -103,4 +103,4 @@ public class Parse<T, O> {
return null;
}
}
}

View File

@@ -32,4 +32,4 @@ public class NoSuchRendererException extends RuntimeException {
super("No renderer for object '" + object + "' of type '" + object.getClass() + "'");
}
}
}

View File

@@ -23,7 +23,7 @@ import ratpack.func.Function;
* A promise for a single value.
* <p>
* A promise is a representation of a value which will become available later.
* Methods such as {@link #map(Function)}, {@link #flatMap(Function)}, {@link #cache()} etc.) allow a pipeline of “operations to be specified,
* Methods such as {@link #map(Function)}, {@link #flatMap(Function)}, {@link #cache()} etc.) allow a pipeline of “operations" to be specified,
* that the value will travel through as it becomes available.
* Such operations are implemented via the {@link #transform(Function)} method.
* Each operation returns a new promise object, not the original promise object.

View File

@@ -37,4 +37,4 @@ import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.PARAMETER})
public @interface NonBlocking {
}
}

View File

@@ -44,4 +44,4 @@ public class NotInRegistryException extends RuntimeException {
public NotInRegistryException(String message) {
super(message);
}
}
}

View File

@@ -173,7 +173,7 @@ public interface Registry {
* Creates a new registry by joining {@code this} registry with the given registry
* <p>
* The returned registry is effectively the union of the two registries, with the {@code child} registry taking precedence.
* This means that child entries are effectively returned first.
* This means that child entries are effectively "returned first".
* <pre class="java">{@code
* import ratpack.exec.registry.Registry;
*

View File

@@ -26,4 +26,4 @@ package ratpack.exec.stream;
* @param <T> the type of item emitted by this publisher
*/
public interface TransformablePublisher<T> {
}
}

View File

@@ -263,4 +263,4 @@ public interface Action<T> {
interface ConditionalSpec<I> {
ConditionalSpec<I> when(Predicate<? super I> predicate, Action<? super I> action);
}
}
}

View File

@@ -174,7 +174,7 @@ public interface Function<I, O> {
* Creates a function that delegates based on the specified conditions.
* <p>
* If no conditions match, an {@link IllegalArgumentException} will be thrown.
* Use {@link #conditional(Function, Action)} alternatively to specify a different else strategy.
* Use {@link #conditional(Function, Action)} alternatively to specify a different "else" strategy.
*
* @param conditions the conditions
* @param <I> the input type
@@ -205,4 +205,4 @@ public interface Function<I, O> {
static <I, O> Function<I, O> conditional(Function<? super I, ? extends O> onElse, Action<? super ConditionalSpec<I, O>> conditions) throws Exception {
return null;
}
}
}

View File

@@ -98,4 +98,4 @@ public interface MultiValueMap<K, V> extends Map<K, V> {
ListMultimap<K, V> asMultimap();
}
}

View File

@@ -22,7 +22,7 @@ package ratpack.func;
* This type serves the same purpose as the JDK's {@link java.util.function.Predicate}, but allows throwing checked exceptions.
* It contains methods for bridging to and from the JDK type.
*
* @param <T> the type of object tested by the predicate
* @param <T> the type of object "tested" by the predicate
*/
@FunctionalInterface
public interface Predicate<T> {
@@ -30,7 +30,7 @@ public interface Predicate<T> {
/**
* Tests the given value.
*
* @param t the value to test
* @param t the value to "test"
* @return {@code true} if the predicate applied, otherwise {@code false}
* @throws Exception any
*/
@@ -93,4 +93,4 @@ public interface Predicate<T> {
return null;
}
}
}