Skip navigation links
A B C D E F G H I L M N O P R S T U V W 

A

accept(A, B, C, D, E, F, G, H, I, J) - Method in interface com.liferay.apio.architect.consumer.DecaConsumer
Operates with ten parameters and returns void.
accept(A, B, C, D, E, F, G, H, I) - Method in interface com.liferay.apio.architect.consumer.EnneaConsumer
Operates with nine parameters and returns void.
accept(A, B, C, D, E, F, G) - Method in interface com.liferay.apio.architect.consumer.HeptaConsumer
Operates with nine parameters and returns void.
accept(A, B, C, D, E, F) - Method in interface com.liferay.apio.architect.consumer.HexaConsumer
Operates with six parameters and returns void.
accept(A, B, C, D, E, F, G, H) - Method in interface com.liferay.apio.architect.consumer.OctaConsumer
Operates with eight parameters and returns void.
accept(A, B, C, D, E) - Method in interface com.liferay.apio.architect.consumer.PentaConsumer
Operates with five parameters and returns void.
accept(A, B, C, D) - Method in interface com.liferay.apio.architect.consumer.TetraConsumer
Operates with four parameters and returns void.
accept(A, B) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableBiConsumer
Operates with two parameters and returns void.
accept(A) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableConsumer
Operates with one parameter and returns void.
accept(A, B, C, D, E, F, G, H, I, J) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableDecaConsumer
Operates with ten parameters and returns void.
accept(A, B, C, D, E, F, G, H, I) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableEnneaConsumer
Operates with nine parameters and returns void.
accept(A, B, C, D, E, F, G) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableHeptaConsumer
Operates with nine parameters and returns void.
accept(A, B, C, D, E, F) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableHexaConsumer
Operates with six parameters and returns void.
accept(A, B, C, D, E, F, G, H) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableOctaConsumer
Operates with eight parameters and returns void.
accept(A, B, C, D, E) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowablePentaConsumer
Operates with five parameters and returns void.
accept(A, B, C, D) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableTetraConsumer
Operates with four parameters and returns void.
accept(A, B, C) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableTriConsumer
Operates with three parameters and returns void.
accept(A, B, C, D, E, F, G, H, I, J, K) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableUndecaConsumer
Operates with eleven parameters and returns void.
accept(A, B, C) - Method in interface com.liferay.apio.architect.consumer.TriConsumer
Operates with three parameters and returns void.
accept(A, B, C, D, E, F, G, H, I, J, K) - Method in interface com.liferay.apio.architect.consumer.UndecaConsumer
Operates with eleven parameters and returns void.
AcceptLanguage - Interface in com.liferay.apio.architect.language
Represents information about the requested languages.
ActionRouter<T extends Identifier<?>> - Interface in com.liferay.apio.architect.router
Represents the mapping between HTTP requests for a resource and the functions that perform those requests.
Actions - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that namespaces action annotations.
Actions.Action - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that indicates a method performs a generic action.
Actions.Create - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that indicates a method creates elements.
Actions.Remove - Annotation Type in com.liferay.apio.architect.annotation
Indicates that a method performs the action of removing elements.
Actions.Replace - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that indicates a method replaces an element.
Actions.Retrieve - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that indicates a method retrieves elements.
Actions.Update - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that indicates a method updates an element.
addApplicationRelativeURL(String, Function<T, String>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a resource's application relative URL field.
addBidirectionalModel(String, String, Class<? extends Identifier<S>>, Function<T, S>) - Method in interface com.liferay.apio.architect.representor.Representor.FirstStep
Adds information about the bidirectional relation of a linked resource in the actual resource and a collection of items in the related resource.
addBinary(String, BinaryFunction<T>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds binary files to a resource.
addBoolean(String, Function<T, Boolean>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a resource's boolean field.
addBooleanList(String, Function<T, List<Boolean>>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a resource's boolean list field.
addCreator(ThrowableBiFunction<R, A, T>, Class<A>, HasAddingPermissionFunction, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableBiFunction<R, A, T>, ThrowableBiFunction<List<R>, A, List<S>>, Class<A>, HasAddingPermissionFunction, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableFunction<R, T>, HasAddingPermissionFunction, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableFunction<R, T>, ThrowableFunction<List<R>, List<S>>, HasAddingPermissionFunction, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowablePentaFunction<R, A, B, C, D, T>, Class<A>, Class<B>, Class<C>, Class<D>, HasAddingPermissionFunction, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowablePentaFunction<R, A, B, C, D, T>, ThrowablePentaFunction<List<R>, A, B, C, D, List<S>>, Class<A>, Class<B>, Class<C>, Class<D>, HasAddingPermissionFunction, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableTetraFunction<R, A, B, C, T>, Class<A>, Class<B>, Class<C>, HasAddingPermissionFunction, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableTetraFunction<R, A, B, C, T>, ThrowableTetraFunction<List<R>, A, B, C, List<S>>, Class<A>, Class<B>, Class<C>, HasAddingPermissionFunction, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableTriFunction<R, A, B, T>, Class<A>, Class<B>, HasAddingPermissionFunction, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableTriFunction<R, A, B, T>, ThrowableTriFunction<List<R>, A, B, List<S>>, Class<A>, Class<B>, HasAddingPermissionFunction, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableBiFunction<U, R, T>, HasNestedAddingPermissionFunction<U>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableBiFunction<U, R, T>, ThrowableBiFunction<U, List<R>, List<S>>, HasNestedAddingPermissionFunction<U>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableHexaFunction<U, R, A, B, C, D, T>, Class<A>, Class<B>, Class<C>, Class<D>, HasNestedAddingPermissionFunction<U>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableHexaFunction<U, R, A, B, C, D, T>, ThrowableHexaFunction<U, List<R>, A, B, C, D, List<S>>, Class<A>, Class<B>, Class<C>, Class<D>, HasNestedAddingPermissionFunction<U>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowablePentaFunction<U, R, A, B, C, T>, Class<A>, Class<B>, Class<C>, HasNestedAddingPermissionFunction<U>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowablePentaFunction<U, R, A, B, C, T>, ThrowablePentaFunction<U, List<R>, A, B, C, List<S>>, Class<A>, Class<B>, Class<C>, HasNestedAddingPermissionFunction<U>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableTetraFunction<U, R, A, B, T>, Class<A>, Class<B>, HasNestedAddingPermissionFunction<U>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableTetraFunction<U, R, A, B, T>, ThrowableTetraFunction<U, List<R>, A, B, List<S>>, Class<A>, Class<B>, HasNestedAddingPermissionFunction<U>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableTriFunction<U, R, A, T>, Class<A>, HasNestedAddingPermissionFunction<U>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCreator(ThrowableTriFunction<U, R, A, T>, ThrowableTriFunction<U, List<R>, A, List<S>>, Class<A>, HasNestedAddingPermissionFunction<U>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Create annotation instead
addCustomRoute(CustomRoute, ThrowableBiFunction<Pagination, R, U>, Class<I>, Function<Credentials, Boolean>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Action annotation instead
addCustomRoute(CustomRoute, ThrowableHexaFunction<Pagination, R, A, B, C, D, U>, Class<A>, Class<B>, Class<C>, Class<D>, Class<I>, Function<Credentials, Boolean>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Action annotation instead
addCustomRoute(CustomRoute, ThrowablePentaFunction<Pagination, R, A, B, C, U>, Class<A>, Class<B>, Class<C>, Class<I>, Function<Credentials, Boolean>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Action annotation instead
addCustomRoute(CustomRoute, ThrowableTetraFunction<Pagination, R, A, B, U>, Class<A>, Class<B>, Class<I>, Function<Credentials, Boolean>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Action annotation instead
addCustomRoute(CustomRoute, ThrowableTriFunction<Pagination, R, A, U>, Class<A>, Class<I>, Function<Credentials, Boolean>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Action annotation instead
addCustomRoute(CustomRoute, ThrowableBiFunction<S, R, U>, Class<I>, BiFunction<Credentials, S, Boolean>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Action annotation instead
addCustomRoute(CustomRoute, ThrowableHexaFunction<S, R, A, B, C, D, U>, Class<A>, Class<B>, Class<C>, Class<D>, Class<I>, BiFunction<Credentials, S, Boolean>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Action annotation instead
addCustomRoute(CustomRoute, ThrowablePentaFunction<S, R, A, B, C, U>, Class<A>, Class<B>, Class<C>, Class<I>, BiFunction<Credentials, S, Boolean>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Action annotation instead
addCustomRoute(CustomRoute, ThrowableTetraFunction<S, R, A, B, U>, Class<A>, Class<B>, Class<I>, BiFunction<Credentials, S, Boolean>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Action annotation instead
addCustomRoute(CustomRoute, ThrowableTriFunction<S, R, A, U>, Class<A>, Class<I>, BiFunction<Credentials, S, Boolean>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Action annotation instead
addDate(String, Function<T, Date>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a resource's date field.
addDescription(String, String) - Method in interface com.liferay.apio.architect.documentation.contributor.CustomDocumentation.Builder
Adds a description for the name.
addGetter(ThrowableBiFunction<Pagination, A, PageItems<T>>, Class<A>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableFunction<Pagination, PageItems<T>>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowablePentaFunction<Pagination, A, B, C, D, PageItems<T>>, Class<A>, Class<B>, Class<C>, Class<D>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableTetraFunction<Pagination, A, B, C, PageItems<T>>, Class<A>, Class<B>, Class<C>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableTriFunction<Pagination, A, B, PageItems<T>>, Class<A>, Class<B>) - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableBiFunction<S, A, T>, Class<A>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableFunction<S, T>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowablePentaFunction<S, A, B, C, D, T>, Class<A>, Class<B>, Class<C>, Class<D>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableTetraFunction<S, A, B, C, T>, Class<A>, Class<B>, Class<C>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableTriFunction<S, A, B, T>, Class<A>, Class<B>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableBiFunction<Pagination, U, PageItems<T>>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableHexaFunction<Pagination, U, A, B, C, D, PageItems<T>>, Class<A>, Class<B>, Class<C>, Class<D>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowablePentaFunction<Pagination, U, A, B, C, PageItems<T>>, Class<A>, Class<B>, Class<C>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableTetraFunction<Pagination, U, A, B, PageItems<T>>, Class<A>, Class<B>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addGetter(ThrowableTriFunction<Pagination, U, A, PageItems<T>>, Class<A>) - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Retrieve annotation instead
addLink(String, String) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a resource link.
addLinkedModel(String, Class<? extends Identifier<V>>, Function<T, V>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about an embeddable related resource.
addLocalizedDescription(String, Function<Locale, String>) - Method in interface com.liferay.apio.architect.documentation.contributor.CustomDocumentation.Builder
Adds the name's localized description via the function that takes the locale and returns the description.
addLocalizedStringByLanguage(String, BiFunction<T, AcceptLanguage, String>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Provides information about a resource localized string field.
addLocalizedStringByLocale(String, BiFunction<T, Locale, String>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Provides information about a resource localized string field.
addNested(String, Function<T, V>, Function<NestedRepresentor.Builder<V>, NestedRepresentor<V>>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Provides information about a nested field.
addNestedList(String, Function<T, List<V>>, Function<NestedRepresentor.Builder<V>, NestedRepresentor<V>>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds a nested list field to the representor.
addNumber(String, Function<T, Number>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a resource's number field.
addNumberList(String, Function<T, List<Number>>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a resource's number list field.
addOptionalBoolean(String, BiConsumer<T, Boolean>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional boolean from the HTTP request body.
addOptionalBooleanList(String, BiConsumer<T, List<Boolean>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional boolean list from the HTTP request body.
addOptionalDate(String, BiConsumer<T, Date>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional date from the HTTP request body.
addOptionalDateList(String, BiConsumer<T, List<Date>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional date list from the HTTP request body.
addOptionalDouble(String, BiConsumer<T, Double>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional double from the HTTP request body.
addOptionalDoubleList(String, BiConsumer<T, List<Double>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional double list from the HTTP request body.
addOptionalFile(String, BiConsumer<T, BinaryFile>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional file from the HTTP request body.
addOptionalFileList(String, BiConsumer<T, List<BinaryFile>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional file list from the HTTP request body.
addOptionalLinkedModel(String, Class<? extends Identifier<C>>, BiConsumer<T, C>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional linked model from the HTTP request body.
addOptionalLinkedModelList(String, Class<? extends Identifier<C>>, BiConsumer<T, List<C>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional list of linked models from the HTTP request body.
addOptionalLong(String, BiConsumer<T, Long>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional long from the HTTP request body.
addOptionalLongList(String, BiConsumer<T, List<Long>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional long list from the HTTP request body.
addOptionalNestedModel(String, FormBuilderFunction<U>, BiConsumer<T, U>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional nested model from the HTTP request body.
addOptionalNestedModelList(String, FormBuilderFunction<U>, BiConsumer<T, List<U>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional nested model list from the HTTP request body.
addOptionalString(String, BiConsumer<T, String>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional string from the HTTP request body.
addOptionalStringList(String, BiConsumer<T, List<String>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests an optional string list from the HTTP request body.
addRelatedCollection(String, Class<S>, Function<T, V>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a related collection.
addRelatedCollection(String, Class<S>) - Method in interface com.liferay.apio.architect.representor.Representor.FirstStep
Adds information about a related collection.
addRelativeURL(String, Function<T, String>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a resource's relative URL field.
addRemover(ThrowableBiConsumer<S, A>, Class<A>, HasRemovePermissionFunction<S>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Remove annotation instead
addRemover(ThrowableConsumer<S>, HasRemovePermissionFunction<S>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Remove annotation instead
addRemover(ThrowablePentaConsumer<S, A, B, C, D>, Class<A>, Class<B>, Class<C>, Class<D>, HasRemovePermissionFunction<S>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Remove annotation instead
addRemover(ThrowableTetraConsumer<S, A, B, C>, Class<A>, Class<B>, Class<C>, HasRemovePermissionFunction<S>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Remove annotation instead
addRemover(ThrowableTriConsumer<S, A, B>, Class<A>, Class<B>, HasRemovePermissionFunction<S>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Remove annotation instead
addRequiredBoolean(String, BiConsumer<T, Boolean>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory boolean from the HTTP request body.
addRequiredBooleanList(String, BiConsumer<T, List<Boolean>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory boolean list from the HTTP request body.
addRequiredDate(String, BiConsumer<T, Date>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory date from the HTTP request body.
addRequiredDateList(String, BiConsumer<T, List<Date>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory date list from the HTTP request body.
addRequiredDouble(String, BiConsumer<T, Double>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory double from the HTTP request body.
addRequiredDoubleList(String, BiConsumer<T, List<Double>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory double list from the HTTP request body.
addRequiredFile(String, BiConsumer<T, BinaryFile>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory file from the HTTP request body.
addRequiredFileList(String, BiConsumer<T, List<BinaryFile>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory file list from the HTTP request body.
addRequiredLinkedModel(String, Class<? extends Identifier<C>>, BiConsumer<T, C>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory linked model from the HTTP request body.
addRequiredLinkedModelList(String, Class<? extends Identifier<C>>, BiConsumer<T, List<C>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory list of linked models from the HTTP request body.
addRequiredLong(String, BiConsumer<T, Long>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory long from the HTTP request body.
addRequiredLongList(String, BiConsumer<T, List<Long>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory long list from the HTTP request body.
addRequiredNestedModel(String, FormBuilderFunction<U>, BiConsumer<T, U>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory nested model from the HTTP request body.
addRequiredNestedModelList(String, FormBuilderFunction<U>, BiConsumer<T, List<U>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory nested model list from the HTTP request body.
addRequiredString(String, BiConsumer<T, String>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory string from the HTTP request body.
addRequiredStringList(String, BiConsumer<T, List<String>>) - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Requests a mandatory string list from the HTTP request body.
addString(String, Function<T, String>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a resource's string field.
addStringList(String, Function<T, List<String>>) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Adds information about a resource's string list field.
addUpdater(ThrowableBiFunction<S, R, T>, HasUpdatePermissionFunction<S>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Replace annotation instead
addUpdater(ThrowableHexaFunction<S, R, A, B, C, D, T>, Class<A>, Class<B>, Class<C>, Class<D>, HasUpdatePermissionFunction<S>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Replace annotation instead
addUpdater(ThrowablePentaFunction<S, R, A, B, C, T>, Class<A>, Class<B>, Class<C>, HasUpdatePermissionFunction<S>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Replace annotation instead
addUpdater(ThrowableTetraFunction<S, R, A, B, T>, Class<A>, Class<B>, HasUpdatePermissionFunction<S>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Replace annotation instead
addUpdater(ThrowableTriFunction<S, R, A, T>, Class<A>, HasUpdatePermissionFunction<S>, FormBuilderFunction<R>) - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions.Replace annotation instead
andThen(DecaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F, ? super G, ? super H, ? super I, ? super J>) - Method in interface com.liferay.apio.architect.consumer.DecaConsumer
Returns the DecaConsumer function that first executes the current DecaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(EnneaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F, ? super G, ? super H, ? super I>) - Method in interface com.liferay.apio.architect.consumer.EnneaConsumer
Returns the EnneaConsumer function that first executes the current EnneaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(HeptaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F, ? super G>) - Method in interface com.liferay.apio.architect.consumer.HeptaConsumer
Returns the HeptaConsumer function that first executes the current HeptaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(HexaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F>) - Method in interface com.liferay.apio.architect.consumer.HexaConsumer
Returns the HexaConsumer function that first executes the current HexaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(OctaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F, ? super G, ? super H>) - Method in interface com.liferay.apio.architect.consumer.OctaConsumer
Returns the OctaConsumer function that first executes the current OctaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(PentaConsumer<? super A, ? super B, ? super C, ? super D, ? super E>) - Method in interface com.liferay.apio.architect.consumer.PentaConsumer
Returns the PentaConsumer function that first executes the current PentaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(TetraConsumer<? super A, ? super B, ? super C, ? super D>) - Method in interface com.liferay.apio.architect.consumer.TetraConsumer
Returns the TetraConsumer function that first executes the current TetraConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowableBiConsumer<? super A, ? super B>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableBiConsumer
Returns the ThrowableBiConsumer function that first executes the current ThrowableBiConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowableConsumer<? super A>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableConsumer
Returns the ThrowableConsumer function that first executes the current ThrowableConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowableDecaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F, ? super G, ? super H, ? super I, ? super J>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableDecaConsumer
Returns the ThrowableDecaConsumer function that first executes the current ThrowableDecaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowableEnneaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F, ? super G, ? super H, ? super I>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableEnneaConsumer
Returns the ThrowableEnneaConsumer function that first executes the current ThrowableEnneaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowableHeptaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F, ? super G>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableHeptaConsumer
Returns the ThrowableHeptaConsumer function that first executes the current ThrowableHeptaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowableHexaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableHexaConsumer
Returns the ThrowableHexaConsumer function that first executes the current ThrowableHexaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowableOctaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F, ? super G, ? super H>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableOctaConsumer
Returns the ThrowableOctaConsumer function that first executes the current ThrowableOctaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowablePentaConsumer<? super A, ? super B, ? super C, ? super D, ? super E>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowablePentaConsumer
Returns the ThrowablePentaConsumer function that first executes the current ThrowablePentaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowableTetraConsumer<? super A, ? super B, ? super C, ? super D>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableTetraConsumer
Returns the ThrowableTetraConsumer function that first executes the current ThrowableTetraConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowableTriConsumer<? super A, ? super B, ? super C>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableTriConsumer
Returns the ThrowableTriConsumer function that first executes the current ThrowableTriConsumer instance's accept method, then executes the after parameter's accept method.
andThen(ThrowableUndecaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F, ? super G, ? super H, ? super I, ? super J, ? super K>) - Method in interface com.liferay.apio.architect.consumer.throwable.ThrowableUndecaConsumer
Returns the ThrowableUndecaConsumer function that first executes the current ThrowableUndecaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(TriConsumer<? super A, ? super B, ? super C>) - Method in interface com.liferay.apio.architect.consumer.TriConsumer
Returns the TriConsumer function that first executes the current TriConsumer instance's accept method, then executes the after parameter's accept method.
andThen(UndecaConsumer<? super A, ? super B, ? super C, ? super D, ? super E, ? super F, ? super G, ? super H, ? super I, ? super J, ? super K>) - Method in interface com.liferay.apio.architect.consumer.UndecaConsumer
Returns the UndecaConsumer function that first executes the current UndecaConsumer instance's accept method, then executes the after parameter's accept method.
andThen(Function<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.DecaFunction
Returns the DecaFunction that first executes the current DecaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(Function<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.EnneaFunction
Returns the EnneaFunction that first executes the current EnneaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(Function<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.HeptaFunction
Returns the HeptaFunction that first executes the current HeptaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(Function<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.HexaFunction
Returns the HexaFunction that first executes the current HexaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(Function<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.OctaFunction
Returns the OctaFunction that first executes the current OctaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(Function<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.PentaFunction
Returns the PentaFunction that first executes the current PentaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(Function<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.TetraFunction
Returns the TetraFunction that first executes the current TetraFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableBiFunction
Returns the ThrowableBiFunction that first executes the current ThrowableBiFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableDecaFunction
Returns the ThrowableDecaFunction that first executes the current ThrowableDecaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableEnneaFunction
Returns the ThrowableEnneaFunction that first executes the current ThrowableEnneaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableFunction
Returns a composed function that first applies the current ThrowableFunction instance to its input, and then applies the throwableFunction to the result.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableHeptaFunction
Returns the ThrowableHeptaFunction that first executes the current ThrowableHeptaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableHexaFunction
Returns the ThrowableHexaFunction that first executes the current ThrowableHexaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableOctaFunction
Returns the ThrowableOctaFunction that first executes the current ThrowableOctaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowablePentaFunction
Returns the ThrowablePentaFunction that first executes the current ThrowablePentaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableTetraFunction
Returns the ThrowableTetraFunction that first executes the current ThrowableTetraFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableTriFunction
Returns the ThrowableTriFunction that first executes the current ThrowableTriFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(ThrowableFunction<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableUndecaFunction
Returns the ThrowableUndecaFunction that first executes the current ThrowableUndecaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(Function<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.TriFunction
Returns the TriFunction that first executes the current TriFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
andThen(Function<? super R, ? extends V>) - Method in interface com.liferay.apio.architect.function.UndecaFunction
Returns the UndecaFunction that first executes the current UndecaFunction instance's apply method, then uses the result as input for the afterFunction parameter's apply method.
APIDescription - Interface in com.liferay.apio.architect.documentation
Returns the API description.
APIError - Class in com.liferay.apio.architect.error
Describes an API error.
APIError(Exception, String, String, int) - Constructor for class com.liferay.apio.architect.error.APIError
 
APIError(Exception, String, String, String, int) - Constructor for class com.liferay.apio.architect.error.APIError
 
ApioLogger - Interface in com.liferay.apio.architect.logger
Deprecated.
As of 1.1.1, with no direct replacement
APITitle - Interface in com.liferay.apio.architect.documentation
Returns the API title.
apply(A, B, C, D, E, F, G, H, I, J) - Method in interface com.liferay.apio.architect.function.DecaFunction
Applies the current DecaFunction and returns a value of type R.
apply(A, B, C, D, E, F, G, H, I) - Method in interface com.liferay.apio.architect.function.EnneaFunction
Applies the current EnneaFunction and returns a value of type R.
apply(A, B, C, D, E, F, G) - Method in interface com.liferay.apio.architect.function.HeptaFunction
Applies the current HeptaFunction and returns a value of type R.
apply(A, B, C, D, E, F) - Method in interface com.liferay.apio.architect.function.HexaFunction
Applies the current HexaFunction and returns a value of type R.
apply(A, B, C, D, E, F, G, H) - Method in interface com.liferay.apio.architect.function.OctaFunction
Applies the current OctaFunction and returns a value of type R.
apply(A, B, C, D, E) - Method in interface com.liferay.apio.architect.function.PentaFunction
Applies the current PentaFunction and returns a value of type R.
apply(A, B, C, D) - Method in interface com.liferay.apio.architect.function.TetraFunction
Applies the current TetraFunction and returns a value of type R.
apply(A, B) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableBiFunction
Applies the current ThrowableBiFunction and returns a value of type R.
apply(A, B, C, D, E, F, G, H, I, J) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableDecaFunction
Applies the current ThrowableDecaFunction and returns a value of type R.
apply(A, B, C, D, E, F, G, H, I) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableEnneaFunction
Applies the current ThrowableEnneaFunction and returns a value of type R.
apply(A) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableFunction
Returns the result of applying the current ThrowableFunction instance to the argument.
apply(A, B, C, D, E, F, G) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableHeptaFunction
Applies the current ThrowableHeptaFunction and returns a value of type R.
apply(A, B, C, D, E, F) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableHexaFunction
Applies the current ThrowableHexaFunction and returns a value of type R.
apply(A, B, C, D, E, F, G, H) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableOctaFunction
Applies the current ThrowableOctaFunction and returns a value of type R.
apply(A, B, C, D, E) - Method in interface com.liferay.apio.architect.function.throwable.ThrowablePentaFunction
Applies the current ThrowablePentaFunction and returns a value of type R.
apply(A, B, C, D) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableTetraFunction
Applies the current ThrowableTetraFunction and returns a value of type R.
apply(A, B, C) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableTriFunction
Applies the current ThrowableTriFunction and returns a value of type R.
apply(A, B, C, D, E, F, G, H, I, J, K) - Method in interface com.liferay.apio.architect.function.throwable.ThrowableUndecaFunction
Applies the current ThrowableUndecaFunction and returns a value of type R.
apply(A, B, C) - Method in interface com.liferay.apio.architect.function.TriFunction
Applies the current TriFunction and returns a value of type R.
apply(A, B, C, D, E, F, G, H, I, J, K) - Method in interface com.liferay.apio.architect.function.UndecaFunction
Applies the current UndecaFunction and returns a value of type R.
asObject() - Method in class com.liferay.apio.architect.resource.Resource.Id
The Resource.Id as an object instance.
asString() - Method in class com.liferay.apio.architect.resource.Resource.Id
The Resource.Id as an string instance.
asURI() - Method in class com.liferay.apio.architect.uri.Path
Returns the current resource's path as a URI.

B

BaseRepresentor<T> - Interface in com.liferay.apio.architect.representor
Base class for Representors.
BaseRepresentor.BaseFirstStep<T,S extends BaseRepresentor<T>,U extends BaseRepresentor.BaseFirstStep<T,S,U>> - Interface in com.liferay.apio.architect.representor
 
BatchCreateItemFunction<T> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to create multiple collection items.
BatchResult<T> - Class in com.liferay.apio.architect.batch
Represents the result of a batch operation.
BatchResult(List<T>, String) - Constructor for class com.liferay.apio.architect.batch.BatchResult
 
BinaryFile - Class in com.liferay.apio.architect.file
 
BinaryFile(InputStream, Long, String) - Constructor for class com.liferay.apio.architect.file.BinaryFile
 
BinaryFile(InputStream, Long, String, String) - Constructor for class com.liferay.apio.architect.file.BinaryFile
 
BinaryFunction<T> - Interface in com.liferay.apio.architect.alias
Defines a type alias for a function that receives a model of type T and returns a binary representation of that model in an InputStream.
Body - Annotation Type in com.liferay.apio.architect.annotation
Defines an action parameter annotation that indicates the parameter must be obtained from the request body.
Body - Interface in com.liferay.apio.architect.form
Represents the current HTTP request body.
build() - Method in interface com.liferay.apio.architect.documentation.contributor.CustomDocumentation.Builder
Constructs and returns a CustomDocumentation instance with the information provided to the builder.
build() - Method in interface com.liferay.apio.architect.form.Form.Builder.FieldStep
Creates and returns the Form instance, using the information provided to the builder.
build() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor.BaseFirstStep
Constructs and returns a NestedRepresentor instance with the information provided to the builder.
build() - Method in interface com.liferay.apio.architect.routes.CollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions annotations instead
build() - Method in interface com.liferay.apio.architect.routes.ItemRoutes.Builder
Deprecated.
As of 1.9.0, use Actions annotations instead
build() - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes.Builder
Deprecated.
As of 1.9.0, use Actions annotations instead

C

CollectionResource<T,S,U extends Identifier<S>> - Interface in com.liferay.apio.architect.resource
Maps your domain models to collection resources that Apio can understand.
CollectionRouter<T,S,U extends Identifier<S>> - Interface in com.liferay.apio.architect.router
Deprecated.
As of 1.9.0, use ActionRouter instead
collectionRoutes(CollectionRoutes.Builder<T, S>) - Method in interface com.liferay.apio.architect.router.CollectionRouter
Deprecated.
As of 1.9.0, use ActionRouter instead
collectionRoutes(NestedCollectionRoutes.Builder<T, S, V>) - Method in interface com.liferay.apio.architect.router.NestedCollectionRouter
Deprecated.
As of 1.9.0, use ActionRouter instead
collectionRoutes(NestedCollectionRoutes.Builder<T, S, W>) - Method in interface com.liferay.apio.architect.router.ReusableNestedCollectionRouter
Deprecated.
As of 1.9.0, use ActionRouter instead
CollectionRoutes<T,S> - Interface in com.liferay.apio.architect.routes
Deprecated.
As of 1.9.0, use Actions annotations instead
CollectionRoutes.Builder<T,S> - Interface in com.liferay.apio.architect.routes
Deprecated.
As of 1.9.0, use Actions annotations instead
com.liferay.apio.architect.alias - package com.liferay.apio.architect.alias
 
com.liferay.apio.architect.alias.form - package com.liferay.apio.architect.alias.form
 
com.liferay.apio.architect.alias.representor - package com.liferay.apio.architect.alias.representor
 
com.liferay.apio.architect.alias.routes - package com.liferay.apio.architect.alias.routes
 
com.liferay.apio.architect.alias.routes.permission - package com.liferay.apio.architect.alias.routes.permission
 
com.liferay.apio.architect.annotation - package com.liferay.apio.architect.annotation
 
com.liferay.apio.architect.batch - package com.liferay.apio.architect.batch
 
com.liferay.apio.architect.consumer - package com.liferay.apio.architect.consumer
 
com.liferay.apio.architect.consumer.throwable - package com.liferay.apio.architect.consumer.throwable
 
com.liferay.apio.architect.credentials - package com.liferay.apio.architect.credentials
 
com.liferay.apio.architect.custom.actions - package com.liferay.apio.architect.custom.actions
 
com.liferay.apio.architect.documentation - package com.liferay.apio.architect.documentation
 
com.liferay.apio.architect.documentation.contributor - package com.liferay.apio.architect.documentation.contributor
 
com.liferay.apio.architect.error - package com.liferay.apio.architect.error
 
com.liferay.apio.architect.exception - package com.liferay.apio.architect.exception
 
com.liferay.apio.architect.exception.mapper - package com.liferay.apio.architect.exception.mapper
 
com.liferay.apio.architect.file - package com.liferay.apio.architect.file
 
com.liferay.apio.architect.form - package com.liferay.apio.architect.form
 
com.liferay.apio.architect.function - package com.liferay.apio.architect.function
 
com.liferay.apio.architect.function.throwable - package com.liferay.apio.architect.function.throwable
 
com.liferay.apio.architect.functional - package com.liferay.apio.architect.functional
 
com.liferay.apio.architect.identifier - package com.liferay.apio.architect.identifier
 
com.liferay.apio.architect.language - package com.liferay.apio.architect.language
 
com.liferay.apio.architect.logger - package com.liferay.apio.architect.logger
 
com.liferay.apio.architect.operation - package com.liferay.apio.architect.operation
 
com.liferay.apio.architect.pagination - package com.liferay.apio.architect.pagination
 
com.liferay.apio.architect.provider - package com.liferay.apio.architect.provider
 
com.liferay.apio.architect.related - package com.liferay.apio.architect.related
 
com.liferay.apio.architect.representor - package com.liferay.apio.architect.representor
 
com.liferay.apio.architect.resource - package com.liferay.apio.architect.resource
 
com.liferay.apio.architect.router - package com.liferay.apio.architect.router
 
com.liferay.apio.architect.routes - package com.liferay.apio.architect.routes
 
com.liferay.apio.architect.single.model - package com.liferay.apio.architect.single.model
 
com.liferay.apio.architect.supplier - package com.liferay.apio.architect.supplier
 
com.liferay.apio.architect.uri - package com.liferay.apio.architect.uri
 
com.liferay.apio.architect.uri.mapper - package com.liferay.apio.architect.uri.mapper
 
constructor(Supplier<T>) - Method in interface com.liferay.apio.architect.form.Form.Builder.ConstructorStep
Adds a supplier that provides an instance of the class that stores the form values.
create(Function<String, Optional<String>>, Function<String, Optional<List<String>>>) - Static method in interface com.liferay.apio.architect.form.Body
Creates and returns a new Body from two lambdas.
create(Function<String, Optional<String>>, Function<String, Optional<List<String>>>, Function<String, Optional<List<BinaryFile>>>, Function<String, Optional<BinaryFile>>) - Static method in interface com.liferay.apio.architect.form.Body
Creates and returns a new Body from four lambdas.
create(List<Body>) - Static method in interface com.liferay.apio.architect.form.Body
Creates and returns a new body with other bodies as members.
createContext(HttpServletRequest) - Method in interface com.liferay.apio.architect.provider.Provider
Creates an instance of T for the current request.
CreateItemFunction<T> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to create a collection item.
Credentials - Interface in com.liferay.apio.architect.credentials
Represents the the current request's credentials.
CustomDocumentation - Interface in com.liferay.apio.architect.documentation.contributor
Holds information about the documentation of the resources' properties and operations.
customDocumentation(CustomDocumentation.Builder) - Method in interface com.liferay.apio.architect.documentation.contributor.CustomDocumentationContributor
Creates a CustomDocumentation instance by using the provided CustomDocumentation.Builder.
CustomDocumentation.Builder - Interface in com.liferay.apio.architect.documentation.contributor
Creates a CustomDocumentation object.
CustomDocumentationContributor - Interface in com.liferay.apio.architect.documentation.contributor
Represents the mapping between properties or operation names and their documentation.
CustomItemFunction<T,S> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to delete a collection item.
CustomPageFunction<U> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to delete a collection item.
CustomRoute - Class in com.liferay.apio.architect.custom.actions
Models a custom resource route.
CustomRoute() - Constructor for class com.liferay.apio.architect.custom.actions.CustomRoute
 

D

DecaConsumer<A,B,C,D,E,F,G,H,I,J> - Interface in com.liferay.apio.architect.consumer
Defines a java.util.function.Consumer that takes ten input parameters.
DecaFunction<A,B,C,D,E,F,G,H,I,J,R> - Interface in com.liferay.apio.architect.function
Defines a Function that takes ten input parameters.
DeleteItemConsumer<T> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to delete a collection item.
DeleteRoute - Class in com.liferay.apio.architect.custom.actions
Models a resource route with DELETE semantics.
DeleteRoute() - Constructor for class com.liferay.apio.architect.custom.actions.DeleteRoute
 
description(Function<AcceptLanguage, String>) - Method in interface com.liferay.apio.architect.form.Form.Builder.DescriptionStep
Adds a function that receives the HTTP request language and returns the form's description.

E

empty() - Static method in interface com.liferay.apio.architect.consumer.DecaConsumer
Returns an empty DecaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.EnneaConsumer
Returns an empty EnneaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.HeptaConsumer
Returns an empty HeptaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.HexaConsumer
Returns an empty HexaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.OctaConsumer
Returns an empty OctaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.PentaConsumer
Returns an empty PentaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.TetraConsumer
Returns an empty TetraConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowableBiConsumer
Returns an empty ThrowableBiConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowableConsumer
Returns an empty ThrowableConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowableDecaConsumer
Returns an empty ThrowableDecaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowableEnneaConsumer
Returns an empty ThrowableEnneaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowableHeptaConsumer
Returns an empty ThrowableHeptaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowableHexaConsumer
Returns an empty ThrowableHexaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowableOctaConsumer
Returns an empty ThrowableOctaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowablePentaConsumer
Returns an empty ThrowablePentaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowableTetraConsumer
Returns an empty ThrowableTetraConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowableTriConsumer
Returns an empty ThrowableTriConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.throwable.ThrowableUndecaConsumer
Returns an empty ThrowableUndecaConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.TriConsumer
Returns an empty TriConsumer that doesn't perform any operation.
empty() - Static method in interface com.liferay.apio.architect.consumer.UndecaConsumer
Returns an empty UndecaConsumer that doesn't perform any operation.
EnneaConsumer<A,B,C,D,E,F,G,H,I> - Interface in com.liferay.apio.architect.consumer
Defines a java.util.function.Consumer that takes nine input parameters.
EnneaFunction<A,B,C,D,E,F,G,H,I,R> - Interface in com.liferay.apio.architect.function
Defines a Function that takes nine input parameters.
EntryPoint - Annotation Type in com.liferay.apio.architect.annotation
Indicates that an action must be listed in the application's entry point.
equals(Object) - Method in class com.liferay.apio.architect.resource.Resource.GenericParent
 
equals(Object) - Method in class com.liferay.apio.architect.resource.Resource.Id
 
equals(Object) - Method in class com.liferay.apio.architect.resource.Resource.Item
 
equals(Object) - Method in class com.liferay.apio.architect.resource.Resource.Nested
 
equals(Object) - Method in class com.liferay.apio.architect.resource.Resource.Paged
 
error(APIError) - Method in interface com.liferay.apio.architect.logger.ApioLogger
Deprecated.
Logs a message in the form of an APIError.
ExceptionMapper<T extends java.lang.Exception> - Interface in com.liferay.apio.architect.exception.mapper
Defines an interface whose instances map between an exception and its APIError representation.

F

fail(Exception) - Static method in class com.liferay.apio.architect.functional.Try
Creates a new Try instance from an exception.
FalsePredicateException - Exception in com.liferay.apio.architect.exception
Defines the exception returned inside Try when Try.filter( java.util.function.Predicate) returns false.
FalsePredicateException(Object) - Constructor for exception com.liferay.apio.architect.exception.FalsePredicateException
 
FieldFunction<T,S> - Interface in com.liferay.apio.architect.alias.representor
Represents the key that represents a model's field and the function to calculate that field.
FieldMode - Enum in com.liferay.apio.architect.annotation
Mode in which a field of a type can be used
FieldType - Enum in com.liferay.apio.architect.form
 
filter(Predicate<T>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
filter(Predicate<T>) - Method in class com.liferay.apio.architect.functional.Try
Returns a Try instance with a value, if that value matches the predicate.
filter(Predicate<T>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
flatMap(ThrowableFunction<? super T, Try<S>>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
flatMap(ThrowableFunction<? super T, Try<S>>) - Method in class com.liferay.apio.architect.functional.Try
Returns the result of applying the mapping function to the Success instance'S value, if the current Try instance is a Success; otherwise returns the Failure instance.
flatMap(ThrowableFunction<? super T, Try<S>>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
fold(Function<Exception, S>, ThrowableFunction<T, S>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
fold(Function<Exception, S>, ThrowableFunction<T, S>) - Method in class com.liferay.apio.architect.functional.Try
Returns the value that results from applying failureFunction if this is a Failure, or successFunction if this is a Success.
fold(Function<Exception, S>, ThrowableFunction<T, S>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
Form<T> - Interface in com.liferay.apio.architect.form
Holds information about an operation's form.
Form.Builder<T> - Interface in com.liferay.apio.architect.form
Creates and populates a Form of type T.
Form.Builder.ConstructorStep<T> - Interface in com.liferay.apio.architect.form
 
Form.Builder.DescriptionStep<T> - Interface in com.liferay.apio.architect.form
 
Form.Builder.FieldStep<T> - Interface in com.liferay.apio.architect.form
 
FormBuilderFunction<T> - Interface in com.liferay.apio.architect.alias.form
Defines a type alias for a function that receives a Form.Builder of type T and returns the constructed Form of type T.
FormField - Interface in com.liferay.apio.architect.form
Represents the field of a Form.
fromFallible(ThrowableSupplier<T>) - Static method in class com.liferay.apio.architect.functional.Try
Creates a new Try instance by executing a fallible lambda in a ThrowableSupplier.
fromFallibleWithResources(ThrowableSupplier<S>, ThrowableFunction<S, T>) - Static method in class com.liferay.apio.architect.functional.Try
Creates a new Try instance by composing two functions: throwableSupplier and throwableFunction.
fromOptional(ThrowableSupplier<Optional<T>>, Supplier<? extends Exception>) - Static method in class com.liferay.apio.architect.functional.Try
Creates a new Try instance by executing a fallible lambda that returns an Optional in a ThrowableSupplier.

G

GenericParentId - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that provides information about a generic parent ID.
get(Body) - Method in interface com.liferay.apio.architect.form.Form
Returns this form's information in a class of type T, where type T matches the type parameter of the Form.Builder that created the form.
get() - Method in class com.liferay.apio.architect.functional.Try.Failure
 
get() - Method in class com.liferay.apio.architect.functional.Try
Returns a Success instance'S value, or a Failure instance'S exception.
get() - Method in class com.liferay.apio.architect.functional.Try.Success
 
get() - Method in interface com.liferay.apio.architect.supplier.ThrowableSupplier
Returns a result of type R if the operation succeeds; otherwise throws an exception.
getApplicationRelativeURLFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list that contains the application relative URL field names and the functions to get those fields.
getBatchCreateItemFunctionOptional() - Method in interface com.liferay.apio.architect.routes.CollectionRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getBinaryFunction(String) - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns a binary resource linked to a model, if present; returns Optional#empty otherwise.
getBinaryFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the binary functions linked to a model.
getBodyMembersOptional() - Method in interface com.liferay.apio.architect.form.Body
Returns a list of nested bodies from the body, if present; returns Optional#empty() otherwise.
getBooleanFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list containing the boolean field names and the functions to get those fields.
getBooleanListFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list containing the boolean list field names and the functions to get those fields.
getCreateItemFunctionOptional() - Method in interface com.liferay.apio.architect.routes.CollectionRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getCustomItemFunctionsOptional() - Method in interface com.liferay.apio.architect.routes.ItemRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getCustomPageFunctionsOptional() - Method in interface com.liferay.apio.architect.routes.CollectionRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getCustomRoute() - Method in interface com.liferay.apio.architect.operation.Operation
Returns the operation's custom route.
getCustomRoutes() - Method in interface com.liferay.apio.architect.routes.CollectionRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getCustomRoutes() - Method in interface com.liferay.apio.architect.routes.ItemRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getDeleteConsumerOptional() - Method in interface com.liferay.apio.architect.routes.ItemRoutes
Deprecated.
use annotation builder instead
getDescription() - Method in class com.liferay.apio.architect.error.APIError
Returns the API error's description, if present; Optional#empty() otherwise.
getDescription(AcceptLanguage) - Method in interface com.liferay.apio.architect.form.Form
Returns this form's description, which depends on the HTTP request accept language.
getDescriptionFunction(String) - Method in interface com.liferay.apio.architect.documentation.contributor.CustomDocumentation
Returns a function that returns the description of a property or operation for the locale.
getEndPosition() - Method in interface com.liferay.apio.architect.pagination.Pagination
Returns the position of the requested page's last element.
getException() - Method in class com.liferay.apio.architect.error.APIError
Returns the API error's original exception.
getException() - Method in class com.liferay.apio.architect.functional.Try.Failure
Returns the current Failure instance'S exception.
getFieldType() - Method in interface com.liferay.apio.architect.form.FormField
Returns the type of this field.
getFileListOptional(String) - Method in interface com.liferay.apio.architect.form.Body
Returns a list of files from the body, if present; returns Optional#empty() otherwise.
getFileOptional(String) - Method in interface com.liferay.apio.architect.form.Body
Returns a binary file from the body, if present; returns Optional#empty() otherwise.
getForm() - Method in interface com.liferay.apio.architect.form.FormField
Returns the nested form.
getFormFields() - Method in interface com.liferay.apio.architect.form.Form
Returns the list of fields from this Form.
getFormOptional() - Method in class com.liferay.apio.architect.custom.actions.CustomRoute
 
getFormOptional() - Method in interface com.liferay.apio.architect.operation.Operation
Returns this operation's expected form, if present; returns Optional#empty() otherwise.
getFormOptional() - Method in interface com.liferay.apio.architect.routes.CollectionRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getFormOptional() - Method in interface com.liferay.apio.architect.routes.ItemRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getFormOptional() - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getGetPageFunctionOptional() - Method in interface com.liferay.apio.architect.routes.CollectionRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getHttpMethod() - Method in interface com.liferay.apio.architect.operation.Operation
Returns the operation's method.
getId() - Method in interface com.liferay.apio.architect.form.Form
Deprecated.
As of 1.9.0, with no direct replacement
getId() - Method in class com.liferay.apio.architect.uri.Path
Returns the current path's ID.
getIdentifier(T) - Method in interface com.liferay.apio.architect.representor.Representor
Returns the model's identifier.
getIdentifierClass() - Method in interface com.liferay.apio.architect.related.RelatedCollection
Returns the class of the collection items' identifier.
getIdentifierClass() - Method in interface com.liferay.apio.architect.related.RelatedModel
Returns the related resource identifier's class.
getIdentifierFunction() - Method in interface com.liferay.apio.architect.related.RelatedModel
Deprecated.
getIdentifierName() - Method in interface com.liferay.apio.architect.related.RelatedModel
Returns the identifier's name.
getIdentifiers() - Method in class com.liferay.apio.architect.batch.BatchResult
Returns the list of identifiers created in the batch operation.
getIdOptional() - Method in class com.liferay.apio.architect.resource.Resource.Item
The resource's ID, if present; Optional#empty otherwise.
getInputStream() - Method in class com.liferay.apio.architect.file.BinaryFile
 
GetItemFunction<T,S> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to get a collection item.
getItemFunctionOptional() - Method in interface com.liferay.apio.architect.routes.ItemRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getItems() - Method in interface com.liferay.apio.architect.pagination.Page
Returns the page's items.
getItems() - Method in class com.liferay.apio.architect.pagination.PageItems
Returns the page's items.
getItemsPerPage() - Method in interface com.liferay.apio.architect.pagination.Page
Returns the number of items the user selected on the page.
getItemsPerPage() - Method in interface com.liferay.apio.architect.pagination.Pagination
Returns the selected number of items per page.
getKey() - Method in interface com.liferay.apio.architect.alias.representor.FieldFunction
Returns the field key.
getKey() - Method in interface com.liferay.apio.architect.related.RelatedCollection
Returns the relation's key.
getKey() - Method in interface com.liferay.apio.architect.related.RelatedModel
Returns the relation's key.
getLastPageNumber() - Method in interface com.liferay.apio.architect.pagination.Page
Returns the number of the collection's last page.
getLinkFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list containing the links field names and the functions to get those links.
getList(Body) - Method in interface com.liferay.apio.architect.form.Form
Returns multiple form's information in list of classes of type T, where type T matches the type parameter of the Form.Builder that created the form.
getLocales() - Method in interface com.liferay.apio.architect.language.AcceptLanguage
Returns the Stream of the request's preferred Locale, in decreasing order.
getLocales() - Method in interface com.liferay.apio.architect.language.Language
Deprecated.
Returns the Stream of the request's preferred Locale, in decreasing order.
getLocalizedStringFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns a map containing the localized string field names and the functions to get those fields.
getMessage() - Method in class com.liferay.apio.architect.error.APIError
Returns the API error's message.
getMethod() - Method in class com.liferay.apio.architect.custom.actions.CustomRoute
 
getMethod() - Method in class com.liferay.apio.architect.custom.actions.DeleteRoute
 
getMethod() - Method in class com.liferay.apio.architect.custom.actions.GetRoute
 
getMethod() - Method in class com.liferay.apio.architect.custom.actions.PostRoute
 
getMethod() - Method in class com.liferay.apio.architect.custom.actions.PutRoute
 
getMimeType() - Method in class com.liferay.apio.architect.file.BinaryFile
 
getModel() - Method in interface com.liferay.apio.architect.single.model.SingleModel
Returns the model.
getModelToIdentifierFunction() - Method in interface com.liferay.apio.architect.related.RelatedCollection
Returns the function you can use to retrieve the related resource's identifier.
getModelToIdentifierFunction() - Method in interface com.liferay.apio.architect.related.RelatedModel
Returns the function you can use to retrieve the related resource's identifier.
getName() - Method in class com.liferay.apio.architect.custom.actions.CustomRoute
 
getName() - Method in class com.liferay.apio.architect.file.BinaryFile
 
getName() - Method in interface com.liferay.apio.architect.form.FormField
Returns the name of the field.
getName() - Method in interface com.liferay.apio.architect.operation.Operation
Returns the operation's name.
getName() - Method in interface com.liferay.apio.architect.representor.Representable
Returns the resource's name.
getName() - Method in class com.liferay.apio.architect.resource.Resource
The resource's name
getName() - Method in class com.liferay.apio.architect.uri.Path
Returns the current path's name.
getNestedBatchCreateItemFunctionOptional() - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getNestedBodyListOptional(String) - Method in interface com.liferay.apio.architect.form.Body
Returns a nested body list from the body, if present; returns Optional#empty() otherwise.
getNestedBodyOptional(String) - Method in interface com.liferay.apio.architect.form.Body
Returns a nested body from the body, if present; returns Optional#empty() otherwise.
getNestedCreateItemFunctionOptional() - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getNestedFieldFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list of nested field functions.
getNestedGetPageFunctionOptional() - Method in interface com.liferay.apio.architect.routes.NestedCollectionRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getNestedListFieldFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list of nested list field functions.
getNestedRepresentor() - Method in interface com.liferay.apio.architect.alias.representor.NestedFieldFunction
Returns the field's NestedRepresentor.
getNestedRepresentor() - Method in interface com.liferay.apio.architect.alias.representor.NestedListFieldFunction
Returns the field's NestedRepresentor.
getNumberFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list containing the number field names and the functions to get those fields.
getNumberListFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list containing the number list field names and the functions to get those fields.
getOperations() - Method in interface com.liferay.apio.architect.pagination.Page
Deprecated.
As of 1.9.0, with no direct replacement
getOperations() - Method in interface com.liferay.apio.architect.single.model.SingleModel
Deprecated.
As of 1.9.0, with no direct replacement
GetPageFunction<T> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to get a collection page.
getPageNumber() - Method in interface com.liferay.apio.architect.pagination.Page
Returns the page number in the collection.
getPageNumber() - Method in interface com.liferay.apio.architect.pagination.Pagination
Returns the requested page's number.
getParentIdOptional() - Method in class com.liferay.apio.architect.resource.Resource.GenericParent
The resource's generic parent ID.
getParentItem() - Method in class com.liferay.apio.architect.resource.Resource.Nested
The resource's parent Resource.Item
getParentName() - Method in class com.liferay.apio.architect.resource.Resource.GenericParent
The resource's generic parent name.
getPathOptional() - Method in interface com.liferay.apio.architect.pagination.Page
Deprecated.
As of 1.9.0, use Page.getResource() instead
getPreferredLocale() - Method in interface com.liferay.apio.architect.language.AcceptLanguage
Returns the first Locale added on the Accept-Language header.
getPreferredLocale() - Method in interface com.liferay.apio.architect.language.Language
Deprecated.
Returns the first Locale added on the Accept-Language header.
getPrimaryType() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the primary type.
getRelatedCollections() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the related collections.
getRelatedModels() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the related models.
getRelativeURLFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list containing the relative URL field names and the functions to get those fields.
getResource() - Method in interface com.liferay.apio.architect.pagination.Page
The page's resource.
getResourceName() - Method in interface com.liferay.apio.architect.pagination.Page
Deprecated.
As of 1.9.0, use Page.getResource() instead
getResourceName() - Method in interface com.liferay.apio.architect.single.model.SingleModel
Returns the resource's name.
GetRoute - Class in com.liferay.apio.architect.custom.actions
Models a resource route with GET semantics
GetRoute() - Constructor for class com.liferay.apio.architect.custom.actions.GetRoute
 
getSize() - Method in class com.liferay.apio.architect.file.BinaryFile
 
getStartPosition() - Method in interface com.liferay.apio.architect.pagination.Pagination
Returns the position of the requested page's first element.
getStatusCode() - Method in class com.liferay.apio.architect.error.APIError
Returns the API error's HTTP status code.
getStringFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list containing the string field names and the functions to get those fields.
getStringListFunctions() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the list containing the string list field names and the functions to get those fields.
getTitle() - Method in class com.liferay.apio.architect.error.APIError
Returns the API error's title.
getTitle(AcceptLanguage) - Method in interface com.liferay.apio.architect.form.Form
Returns the form's title, which depends on the HTTP request accept language.
getTotalCount() - Method in interface com.liferay.apio.architect.pagination.Page
Returns the total number of elements in the collection.
getTotalCount() - Method in class com.liferay.apio.architect.pagination.PageItems
Returns the total number of elements in the collection.
getType() - Method in class com.liferay.apio.architect.error.APIError
Returns the API error's type.
getTypes() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Returns the types.
getUnchecked() - Method in class com.liferay.apio.architect.functional.Try.Failure
 
getUnchecked() - Method in class com.liferay.apio.architect.functional.Try
Returns a Success instance'S value, or a Failure instance'S exception wrapped in a RuntimeException.
getUnchecked() - Method in class com.liferay.apio.architect.functional.Try.Success
 
getUpdateItemFunctionOptional() - Method in interface com.liferay.apio.architect.routes.ItemRoutes
Deprecated.
As of 1.9.0, use Actions annotations instead
getURIOptional() - Method in interface com.liferay.apio.architect.operation.Operation
Returns the operation's URI.
getValue() - Method in class com.liferay.apio.architect.functional.Try.Success
Returns the current Success instance'S value.
getValueListOptional(String) - Method in interface com.liferay.apio.architect.form.Body
Returns a list of values from the body, if present; returns Optional#empty() otherwise.
getValueOptional(String) - Method in interface com.liferay.apio.architect.form.Body
Returns a value from the body, if present; returns Optional#empty() otherwise.

H

HasAddingPermissionFunction - Interface in com.liferay.apio.architect.alias.routes.permission
Defines a type alias for a function that can be used to check for permissions for adding an item to a collection.
hashCode() - Method in class com.liferay.apio.architect.resource.Resource.GenericParent
 
hashCode() - Method in class com.liferay.apio.architect.resource.Resource.Id
 
hashCode() - Method in class com.liferay.apio.architect.resource.Resource.Item
 
hashCode() - Method in class com.liferay.apio.architect.resource.Resource.Nested
 
hashCode() - Method in class com.liferay.apio.architect.resource.Resource.Paged
 
HasNestedAddingPermissionFunction<T> - Interface in com.liferay.apio.architect.alias.routes.permission
Defines a type alias for a function that can be used to check for permissions for adding an item to a nested collection.
hasNext() - Method in interface com.liferay.apio.architect.pagination.Page
Returns true if another page follows this page in the collection.
hasPrevious() - Method in interface com.liferay.apio.architect.pagination.Page
Returns true if another page precedes this page in the collection.
HasRemovePermissionFunction<T> - Interface in com.liferay.apio.architect.alias.routes.permission
Defines a type alias for a function that can be used to check for permissions for deleting an item.
HasUpdatePermissionFunction<T> - Interface in com.liferay.apio.architect.alias.routes.permission
Defines a type alias for a function that can be used to check for permissions for updating an item.
HeptaConsumer<A,B,C,D,E,F,G> - Interface in com.liferay.apio.architect.consumer
Defines a java.util.function.Consumer that takes seven input parameters.
HeptaFunction<A,B,C,D,E,F,G,R> - Interface in com.liferay.apio.architect.function
Defines a Function that takes seven input parameters.
HexaConsumer<A,B,C,D,E,F> - Interface in com.liferay.apio.architect.consumer
Defines a java.util.function.Consumer that takes six input parameters.
HexaFunction<A,B,C,D,E,F,R> - Interface in com.liferay.apio.architect.function
Defines a Function that takes six input parameters.
HTTPMethod - Enum in com.liferay.apio.architect.operation
Represents the methods that allow for an Operation.

I

Id - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that provides information about a type ID.
Identifier<T> - Interface in com.liferay.apio.architect.identifier
Represents a resource identifier.
identifier(Function<T, U>) - Method in interface com.liferay.apio.architect.representor.Representor.IdentifierStep
Provides a lambda function that can be used to obtain a model's identifier.
IdentifierFunction<T> - Interface in com.liferay.apio.architect.alias
Defines a type alias for a function that receives a Path and returns the identifier from that Path.
ifFailure(Consumer<Exception>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
ifFailure(Consumer<Exception>) - Method in class com.liferay.apio.architect.functional.Try
Calls the provided consumer if the current Try instance is a Failure; otherwise nothing occurs.
ifFailure(Consumer<Exception>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
ifSuccess(Consumer<T>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
ifSuccess(Consumer<T>) - Method in class com.liferay.apio.architect.functional.Try
Calls the provided consumer if the current Try instance is a Success; otherwise nothing occurs.
ifSuccess(Consumer<T>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
isCollection() - Method in interface com.liferay.apio.architect.operation.Operation
Whether this is a collection's operation.
isCustom() - Method in interface com.liferay.apio.architect.operation.Operation
Returns true if this is a custom operation.
isFailure() - Method in class com.liferay.apio.architect.functional.Try.Failure
 
isFailure() - Method in class com.liferay.apio.architect.functional.Try
Returns true if the current Try instance is a Failure; otherwise returns false.
isFailure() - Method in class com.liferay.apio.architect.functional.Try.Success
 
isNested() - Method in interface com.liferay.apio.architect.representor.BaseRepresentor
Whether this representor is a NestedRepresentor.
isRequired() - Method in interface com.liferay.apio.architect.form.FormField
Returns true if the field is required in this Form; false otherwise.
isSuccess() - Method in class com.liferay.apio.architect.functional.Try.Failure
 
isSuccess() - Method in class com.liferay.apio.architect.functional.Try
Returns true if the current Try instance is a Success; otherwise returns false.
isSuccess() - Method in class com.liferay.apio.architect.functional.Try.Success
 
ItemResource<T,S,U extends Identifier<S>> - Interface in com.liferay.apio.architect.resource
Maps your domain models to item resources that Apio can understand.
ItemRouter<T,S,U extends Identifier<S>> - Interface in com.liferay.apio.architect.router
Deprecated.
As of 1.9.0, use ActionRouter instead
itemRoutes(ItemRoutes.Builder<T, S>) - Method in interface com.liferay.apio.architect.router.ItemRouter
Deprecated.
As of 1.9.0, use ActionRouter instead
ItemRoutes<T,S> - Interface in com.liferay.apio.architect.routes
Deprecated.
As of 1.9.0, use Actions annotations instead
ItemRoutes.Builder<T,S> - Interface in com.liferay.apio.architect.routes
Deprecated.
As of 1.9.0, use Actions annotations instead

L

Language - Interface in com.liferay.apio.architect.language
Deprecated.
As of 1.0.0, replaced by AcceptLanguage

M

map(T) - Method in interface com.liferay.apio.architect.exception.mapper.ExceptionMapper
Converts an exception to its APIError representation.
map(ThrowableFunction<? super T, ? extends S>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
map(ThrowableFunction<? super T, ? extends S>) - Method in class com.liferay.apio.architect.functional.Try
Returns the result of applying the mapping function to the Success instance'S value, if the current Try instance is a Success; otherwise returns the Failure instance.
map(ThrowableFunction<? super T, ? extends S>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
map(Path) - Method in interface com.liferay.apio.architect.uri.mapper.PathIdentifierMapper
Converts a path to its corresponding identifier.
map(String, T) - Method in interface com.liferay.apio.architect.uri.mapper.PathIdentifierMapper
Converts an identifier to its corresponding path.
mapFail(Function<Exception, S>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
mapFail(Function<Exception, S>) - Method in class com.liferay.apio.architect.functional.Try
Returns a Try instance that contains the result of applying the mapping function to the current Try instance'S exception, if that instance is a Failure object.
mapFail(Function<Exception, S>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
mapFailMatching(Class<U>, Supplier<S>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
mapFailMatching(Class<U>, Supplier<S>) - Method in class com.liferay.apio.architect.functional.Try
Returns a Try instance that contains the exception provided by the Supplier, if the current Try instance is a Failure object whose exception class matches that of the exceptionClass parameter.
mapFailMatching(Class<U>, Supplier<S>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
mapOptional(ThrowableFunction<? super T, ? extends Optional<S>>) - Method in class com.liferay.apio.architect.functional.Try
Returns the result of applying the mapping function to the Success instance's value and unwrapping the resulting Optional, if the current Try instance is a Success and the Optional isn't Optional#empty(); otherwise returns the Failure.
mapOptional(ThrowableFunction<? super T, ? extends Optional<S>>, Supplier<? extends Exception>) - Method in class com.liferay.apio.architect.functional.Try
Returns the result of applying the mapping function to the Success instance's value and unwrapping the resulting Optional, if the current Try instance is a Success and the Optional isn't Optional#empty(); otherwise returns the Failure instance with the provided exception.

N

Nested(Resource.Item, String) - Constructor for class com.liferay.apio.architect.resource.Resource.Nested
 
NestedBatchCreateItemFunction<T,S> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to create a nested collection item.
NestedCollectionResource<T,S,U extends Identifier<S>,V,W extends Identifier<V>> - Interface in com.liferay.apio.architect.resource
Maps your domain models to nested collection resources that Apio can understand.
NestedCollectionRouter<T,S,U extends Identifier<S>,V,W extends Identifier<V>> - Interface in com.liferay.apio.architect.router
Deprecated.
As of 1.9.0, use ActionRouter instead
NestedCollectionRoutes<T,S,U> - Interface in com.liferay.apio.architect.routes
Deprecated.
As of 1.9.0, use Actions annotations instead
NestedCollectionRoutes.Builder<T,S,U> - Interface in com.liferay.apio.architect.routes
Deprecated.
As of 1.9.0, use Actions annotations instead
NestedCreateItemFunction<T,S> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to create a nested collection item.
NestedFieldFunction<T,S> - Interface in com.liferay.apio.architect.alias.representor
Represents a representor's nested field.
NestedGetPageFunction<T,S> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to get a nested collection page.
NestedListFieldFunction<T,S> - Interface in com.liferay.apio.architect.alias.representor
Represents a representor's nested list field.
NestedRepresentor<T> - Interface in com.liferay.apio.architect.representor
Holds information about the metadata supported for a nested resource.
NestedRepresentor.Builder<T> - Interface in com.liferay.apio.architect.representor
Creates generic representations of your domain models that Apio hypermedia writers can understand.
NestedRepresentor.FirstStep<T> - Interface in com.liferay.apio.architect.representor
 

O

OctaConsumer<A,B,C,D,E,F,G,H> - Interface in com.liferay.apio.architect.consumer
Defines a java.util.function.Consumer that takes eight input parameters.
OctaFunction<A,B,C,D,E,F,G,H,R> - Interface in com.liferay.apio.architect.function
Defines a Function that takes eight input parameters.
of(String, Resource.Id, String) - Static method in class com.liferay.apio.architect.resource.Resource.GenericParent
Creates a new Resource.GenericParent with the provided parent and name information.
of(String, String) - Static method in class com.liferay.apio.architect.resource.Resource.GenericParent
Creates a new Resource.GenericParent with the provided parent and name information.
of(Object, String) - Static method in class com.liferay.apio.architect.resource.Resource.Id
Creates a new Resource.Id with the provided object-string pair.
of(String) - Static method in class com.liferay.apio.architect.resource.Resource.Item
Creates a new Resource.Item with the provided name.
of(String, Resource.Id) - Static method in class com.liferay.apio.architect.resource.Resource.Item
Creates a new Resource.Item with the provided name and ID.
of(Resource.Item, String) - Static method in class com.liferay.apio.architect.resource.Resource.Nested
Creates a new Resource.Nested with the provided parent and name information.
of(String) - Static method in class com.liferay.apio.architect.resource.Resource.Paged
Creates a new Resource.Paged with the provided name.
Operation - Interface in com.liferay.apio.architect.operation
Represents a resource's operation.
orElse(T) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
orElse(T) - Method in class com.liferay.apio.architect.functional.Try
Returns the Success instance'S value, if the current Try instance is a Success object.
orElse(T) - Method in class com.liferay.apio.architect.functional.Try.Success
 
orElseGet(Supplier<? extends T>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
orElseGet(Supplier<? extends T>) - Method in class com.liferay.apio.architect.functional.Try
Returns the Success instance'S value, if the current Try instance is a Success object.
orElseGet(Supplier<? extends T>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
orElseThrow(Supplier<? extends S>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
orElseThrow(Supplier<? extends S>) - Method in class com.liferay.apio.architect.functional.Try
Returns the Success instance'S value, if the current Try instance is a Success object.
orElseThrow(Supplier<? extends S>) - Method in class com.liferay.apio.architect.functional.Try.Success
 

P

Page<T> - Interface in com.liferay.apio.architect.pagination
Represents a page in a collection.
PageItems<T> - Class in com.liferay.apio.architect.pagination
Provides the information needed by Apio Architect to construct a valid Page.
PageItems(Collection<T>, int) - Constructor for class com.liferay.apio.architect.pagination.PageItems
 
Pagination - Interface in com.liferay.apio.architect.pagination
Defines pagination for a collection endpoint.
ParentId - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that provides information about a parent type ID.
Path - Class in com.liferay.apio.architect.uri
Represents a resource path.
Path(String, String) - Constructor for class com.liferay.apio.architect.uri.Path
 
PathIdentifierMapper<T> - Interface in com.liferay.apio.architect.uri.mapper
Converts a Path to its corresponding identifier, and vice versa.
PentaConsumer<A,B,C,D,E> - Interface in com.liferay.apio.architect.consumer
Defines a java.util.function.Consumer that takes five input parameters.
PentaFunction<A,B,C,D,E,R> - Interface in com.liferay.apio.architect.function
Defines a Function that takes five input parameters.
Permissions - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that namespaces permission annotations.
Permissions.CanCreate - Annotation Type in com.liferay.apio.architect.annotation
Defines a permission to check a method that creates elements.
Permissions.CanRemove - Annotation Type in com.liferay.apio.architect.annotation
Defines a permission to check a method that removes elements.
Permissions.CanReplace - Annotation Type in com.liferay.apio.architect.annotation
Defines a permission to check a method that replaces an element.
Permissions.CanRetrieve - Annotation Type in com.liferay.apio.architect.annotation
Defines a permission to check a method that retrieves elements.
Permissions.CanUpdate - Annotation Type in com.liferay.apio.architect.annotation
Defines a permission to check a method that updates elements.
Permissions.HasPermission - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that indicates a method performs a permission check before an action.
PostRoute - Class in com.liferay.apio.architect.custom.actions
Models a resource route with POST semantics.
PostRoute() - Constructor for class com.liferay.apio.architect.custom.actions.PostRoute
 
Provider<T> - Interface in com.liferay.apio.architect.provider
Provides instances of T that are dependent on the current request.
PutRoute - Class in com.liferay.apio.architect.custom.actions
Models a resource route with PUT semantics.
PutRoute() - Constructor for class com.liferay.apio.architect.custom.actions.PutRoute
 

R

recover(Function<? super Exception, T>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
recover(Function<? super Exception, T>) - Method in class com.liferay.apio.architect.functional.Try
Returns the result of applying the function to the Failure object'S exception, if the current Try instance is a Failure object.
recover(Function<? super Exception, T>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
recoverWith(ThrowableFunction<? super Exception, Try<T>>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
recoverWith(ThrowableFunction<? super Exception, Try<T>>) - Method in class com.liferay.apio.architect.functional.Try
Returns a new Try instance extracted from the provided function, if the current Try instance is a Failure object.
recoverWith(ThrowableFunction<? super Exception, Try<T>>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
RelatedCollection<T,S extends Identifier> - Interface in com.liferay.apio.architect.related
Represents the relation between a resource and a collection.
RelatedModel<T,S> - Interface in com.liferay.apio.architect.related
Represents the relation between two resources.
Representable<T,S,U extends Identifier<S>> - Interface in com.liferay.apio.architect.representor
Represents the mapping between an internal model and its generic representation.
representor(Representor.Builder<T, S>) - Method in interface com.liferay.apio.architect.representor.Representable
Creates a Representor for a certain domain model from the provided Representor.Builder.
Representor<T> - Interface in com.liferay.apio.architect.representor
Holds information about the metadata supported for a resource.
Representor.Builder<T,S> - Interface in com.liferay.apio.architect.representor
Creates generic representations of your domain models that Apio hypermedia writers can understand.
Representor.FirstStep<T> - Interface in com.liferay.apio.architect.representor
 
Representor.IdentifierStep<T,U> - Interface in com.liferay.apio.architect.representor
 
RequestFunction<T> - Interface in com.liferay.apio.architect.alias
Defines a type alias for a function that receives an HttpServletRequest and returns another item.
Resource - Class in com.liferay.apio.architect.resource
Instances of this class represent an API resource.
Resource.GenericParent - Class in com.liferay.apio.architect.resource
Instances of this class represent a generic parent resource.
Resource.Id - Class in com.liferay.apio.architect.resource
Instances of this class represent an item's ID.
Resource.Item - Class in com.liferay.apio.architect.resource
Instances of this class represent an item resource.
Resource.Nested - Class in com.liferay.apio.architect.resource
Instances of this class represent a nested resource.
Resource.Paged - Class in com.liferay.apio.architect.resource
Instances of this class represent a paged resource.
resourceName - Variable in class com.liferay.apio.architect.batch.BatchResult
The name of the elements' resource created in the batch operation.
ReusableNestedCollectionRouter<T,S,U extends Identifier<S>,W> - Interface in com.liferay.apio.architect.router
Deprecated.
As of 1.9.0, use ActionRouter instead

S

setForm(Form<?>) - Method in class com.liferay.apio.architect.custom.actions.CustomRoute
 
SingleModel<T> - Interface in com.liferay.apio.architect.single.model
Provides a wrapper for a model.
success(T) - Static method in class com.liferay.apio.architect.functional.Try
Creates a new Try instance from an object.

T

TetraConsumer<A,B,C,D> - Interface in com.liferay.apio.architect.consumer
Defines a java.util.function.Consumer that takes four input parameters.
TetraFunction<A,B,C,D,R> - Interface in com.liferay.apio.architect.function
Defines a Function that takes four input parameters.
ThrowableBiConsumer<A,B> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a BiConsumer that can throw an exception.
ThrowableBiFunction<A,B,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a BiFunction that can throw an exception.
ThrowableConsumer<A> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a Consumer that can throw an exception.
ThrowableDecaConsumer<A,B,C,D,E,F,G,H,I,J> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a DecaConsumer that can throw an exception.
ThrowableDecaFunction<A,B,C,D,E,F,G,H,I,J,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a DecaFunction that can throw an exception.
ThrowableEnneaConsumer<A,B,C,D,E,F,G,H,I> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a EnneaConsumer that can throw an exception.
ThrowableEnneaFunction<A,B,C,D,E,F,G,H,I,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a EnneaFunction that can throw an exception.
ThrowableFunction<A,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a java.util.function.Function that can throw an exception.
ThrowableHeptaConsumer<A,B,C,D,E,F,G> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a HeptaConsumer that can throw an exception.
ThrowableHeptaFunction<A,B,C,D,E,F,G,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a HeptaFunction that can throw an exception.
ThrowableHexaConsumer<A,B,C,D,E,F> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a HexaConsumer that can throw an exception.
ThrowableHexaFunction<A,B,C,D,E,F,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a HexaFunction that can throw an exception.
ThrowableOctaConsumer<A,B,C,D,E,F,G,H> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a OctaConsumer that can throw an exception.
ThrowableOctaFunction<A,B,C,D,E,F,G,H,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a OctaFunction that can throw an exception.
ThrowablePentaConsumer<A,B,C,D,E> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a PentaConsumer that can throw an exception.
ThrowablePentaFunction<A,B,C,D,E,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a PentaFunction that can throw an exception.
ThrowableSupplier<R> - Interface in com.liferay.apio.architect.supplier
Defines a java.util.function.Supplier that can throw an exception.
ThrowableTetraConsumer<A,B,C,D> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a TetraConsumer that can throw an exception.
ThrowableTetraFunction<A,B,C,D,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a TetraFunction that can throw an exception.
ThrowableTriConsumer<A,B,C> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a TriConsumer that can throw an exception.
ThrowableTriFunction<A,B,C,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a TriFunction that can throw an exception.
ThrowableUndecaConsumer<A,B,C,D,E,F,G,H,I,J,K> - Interface in com.liferay.apio.architect.consumer.throwable
Defines a UndecaConsumer that can throw an exception.
ThrowableUndecaFunction<A,B,C,D,E,F,G,H,I,J,K,R> - Interface in com.liferay.apio.architect.function.throwable
Defines a UndecaFunction that can throw an exception.
title(Function<AcceptLanguage, String>) - Method in interface com.liferay.apio.architect.form.Form.Builder
Adds a function that receives the HTTP request language and returns the form's title.
toOptional() - Method in class com.liferay.apio.architect.functional.Try.Failure
 
toOptional() - Method in class com.liferay.apio.architect.functional.Try.Success
 
toOptional() - Method in class com.liferay.apio.architect.functional.Try
Returns the current Try instance as an Optional containing the value if it's a Success or Optional#empty() if it's a Failure.
toString() - Method in class com.liferay.apio.architect.resource.Resource.GenericParent
 
toString() - Method in class com.liferay.apio.architect.resource.Resource.Id
 
toString() - Method in class com.liferay.apio.architect.resource.Resource.Item
 
toString() - Method in class com.liferay.apio.architect.resource.Resource.Nested
 
toString() - Method in class com.liferay.apio.architect.resource.Resource.Paged
 
TriConsumer<A,B,C> - Interface in com.liferay.apio.architect.consumer
Defines a java.util.function.Consumer that takes three input parameters.
TriFunction<A,B,C,R> - Interface in com.liferay.apio.architect.function
Defines a Function that takes three input parameters.
Try<T> - Class in com.liferay.apio.architect.functional
Implements the monadic Try type.
Try.Failure<T> - Class in com.liferay.apio.architect.functional
The implementation of Try'S failure case.
Try.Success<T> - Class in com.liferay.apio.architect.functional
The implementation of Try'S success case.
types(String, String...) - Method in interface com.liferay.apio.architect.representor.NestedRepresentor.Builder
Adds a type for the model.
types(String, String...) - Method in interface com.liferay.apio.architect.representor.Representor.Builder
Adds a type for the model.

U

UndecaConsumer<A,B,C,D,E,F,G,H,I,J,K> - Interface in com.liferay.apio.architect.consumer
Defines a java.util.function.Consumer that takes eleven input parameters.
UndecaFunction<A,B,C,D,E,F,G,H,I,J,K,R> - Interface in com.liferay.apio.architect.function
Defines a Function that takes eleven input parameters.
UpdateItemFunction<T,S> - Interface in com.liferay.apio.architect.alias.routes
Defines a type alias for a function that can be used to update a collection item.

V

valueOf(String) - Static method in enum com.liferay.apio.architect.annotation.FieldMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.apio.architect.annotation.Vocabulary.LinkTo.ResourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.apio.architect.form.FieldType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.apio.architect.operation.HTTPMethod
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.liferay.apio.architect.annotation.FieldMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.apio.architect.annotation.Vocabulary.LinkTo.ResourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.apio.architect.form.FieldType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.apio.architect.operation.HTTPMethod
Returns an array containing the constants of this enum type, in the order they are declared.
Vocabulary - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that namespaces vocabulary annotations.
Vocabulary.BidirectionalModel - Annotation Type in com.liferay.apio.architect.annotation
Indicates that a type has a bidirectional link to another resource's page.
Vocabulary.Field - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that provides information about a field.
Vocabulary.LinkedModel - Annotation Type in com.liferay.apio.architect.annotation
Deprecated.
As of 1.9.0, use Vocabulary.LinkTo instead
Vocabulary.LinkTo - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that indicates a field should be expressed as a link (URI) to another resource.
Vocabulary.LinkTo.ResourceType - Enum in com.liferay.apio.architect.annotation
The different type of resources with which another resource can be linked to via Vocabulary.LinkTo.
Vocabulary.RelatedCollection - Annotation Type in com.liferay.apio.architect.annotation
Deprecated.
Vocabulary.RelativeURL - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that indicates a field contains a relative URL that should be expressed as an absolute one.
Vocabulary.Type - Annotation Type in com.liferay.apio.architect.annotation
Defines an annotation that provides information about a type.
voidFold(Consumer<Exception>, ThrowableConsumer<T>) - Method in class com.liferay.apio.architect.functional.Try.Failure
 
voidFold(Consumer<Exception>, ThrowableConsumer<T>) - Method in class com.liferay.apio.architect.functional.Try.Success
 
voidFold(Consumer<Exception>, ThrowableConsumer<T>) - Method in class com.liferay.apio.architect.functional.Try
Applies failureConsumer if the current Try instance is a Failure, or successConsumer if it's a Success.

W

warning(String) - Method in interface com.liferay.apio.architect.logger.ApioLogger
Deprecated.
Logs a warning message.
withId(Resource.Id) - Method in class com.liferay.apio.architect.resource.Resource.Item
Copies the current Resource.Item by setting a value for the ID attribute.
withParentId(Resource.Id) - Method in class com.liferay.apio.architect.resource.Resource.GenericParent
Copies the current Resource.GenericParent by setting a value for the generic parent's ID attribute.
withParentId(Resource.Id) - Method in class com.liferay.apio.architect.resource.Resource.Nested
Copies the current Resource.Nested by setting a value for the parent's ID attribute.
A B C D E F G H I L M N O P R S T U V W 
Skip navigation links