Package org.gitlab4j.api
Class GitLabApiForm
java.lang.Object
jakarta.ws.rs.core.Form
org.gitlab4j.api.GitLabApiForm
public class GitLabApiForm
extends jakarta.ws.rs.core.Form
This class extends the standard JAX-RS Form class to make it fluent.
-
Constructor Summary
ConstructorDescriptionGitLabApiForm
(int page, int perPage) Create a GitLabApiForm instance with the "page", and "per_page" parameters preset.GitLabApiForm
(jakarta.ws.rs.core.MultivaluedHashMap<String, String> map) -
Method Summary
Modifier and TypeMethodDescriptionFluent method for adding query and form parameters to a get() or post() call.Fluent method for adding query and form parameters to a get() or post() call.Fluent method for adding Date query and form parameters to a get() or post() call.Fluent method for adding Date query and form parameters to a get() or post() call.<T> GitLabApiForm
Fluent method for adding a List type query and form parameters to a get() or post() call.<T> GitLabApiForm
Fluent method for adding a List type query and form parameters to a get() or post() call.Fluent method for adding an array of hash type query and form parameters to a get() or post() call.withParam
(String name, AccessLevel level) Fluent method for adding AccessLevel query and form parameters to a get() or post() call.withParam
(String name, AccessLevel level, boolean required) Fluent method for adding AccessLevel query and form parameters to a get() or post() call.Fluent method for adding a List<Variable> type query and form parameters to a get(), post(), or put() call.Methods inherited from class jakarta.ws.rs.core.Form
asMap, param
-
Constructor Details
-
GitLabApiForm
public GitLabApiForm() -
GitLabApiForm
-
GitLabApiForm
public GitLabApiForm(int page, int perPage) Create a GitLabApiForm instance with the "page", and "per_page" parameters preset.- Parameters:
page
- the value for the "page" parameterperPage
- the value for the "per_page" parameter
-
-
Method Details
-
withParam
Fluent method for adding query and form parameters to a get() or post() call.- Parameters:
name
- the name of the field/attribute to addvalue
- the value of the field/attribute to add- Returns:
- this GitLabAPiForm instance
- Throws:
IllegalArgumentException
-
withParam
Fluent method for adding Date query and form parameters to a get() or post() call.- Parameters:
name
- the name of the field/attribute to adddate
- the value of the field/attribute to add- Returns:
- this GitLabAPiForm instance
- Throws:
IllegalArgumentException
-
withParam
public GitLabApiForm withParam(String name, Date date, boolean required) throws IllegalArgumentException Fluent method for adding Date query and form parameters to a get() or post() call.- Parameters:
name
- the name of the field/attribute to adddate
- the value of the field/attribute to addrequired
- the field is required flag- Returns:
- this GitLabAPiForm instance
- Throws:
IllegalArgumentException
- if a required parameter is null or empty
-
withParam
Fluent method for adding AccessLevel query and form parameters to a get() or post() call.- Parameters:
name
- the name of the field/attribute to addlevel
- the value of the field/attribute to add- Returns:
- this GitLabAPiForm instance
- Throws:
IllegalArgumentException
-
withParam
public GitLabApiForm withParam(String name, AccessLevel level, boolean required) throws IllegalArgumentException Fluent method for adding AccessLevel query and form parameters to a get() or post() call.- Parameters:
name
- the name of the field/attribute to addlevel
- the value of the field/attribute to addrequired
- the field is required flag- Returns:
- this GitLabAPiForm instance
- Throws:
IllegalArgumentException
- if a required parameter is null or empty
-
withParam
Fluent method for adding a List type query and form parameters to a get() or post() call.- Type Parameters:
T
- the type contained by the List- Parameters:
name
- the name of the field/attribute to addvalues
- a List containing the values of the field/attribute to add- Returns:
- this GitLabAPiForm instance
-
withParam
public <T> GitLabApiForm withParam(String name, List<T> values, boolean required) throws IllegalArgumentException Fluent method for adding a List type query and form parameters to a get() or post() call.- Type Parameters:
T
- the type contained by the List- Parameters:
name
- the name of the field/attribute to addvalues
- a List containing the values of the field/attribute to addrequired
- the field is required flag- Returns:
- this GitLabAPiForm instance
- Throws:
IllegalArgumentException
- if a required parameter is null or empty
-
withParam
public GitLabApiForm withParam(String name, Map<String, ?> variables, boolean required) throws IllegalArgumentExceptionFluent method for adding an array of hash type query and form parameters to a get() or post() call.- Parameters:
name
- the name of the field/attribute to addvariables
- a Map containing array of hashesrequired
- the field is required flag- Returns:
- this GitLabAPiForm instance
- Throws:
IllegalArgumentException
- if a required parameter is null or empty
-
withParam
public GitLabApiForm withParam(String name, Object value, boolean required) throws IllegalArgumentException Fluent method for adding query and form parameters to a get() or post() call. If required is true and value is null, will throw an IllegalArgumentException.- Parameters:
name
- the name of the field/attribute to addvalue
- the value of the field/attribute to addrequired
- the field is required flag- Returns:
- this GitLabAPiForm instance
- Throws:
IllegalArgumentException
- if a required parameter is null or empty
-
withParam
Fluent method for adding a List<Variable> type query and form parameters to a get(), post(), or put() call.- Parameters:
variables
- the List of Variable to add- Returns:
- this GitLabAPiForm instance
-