Package org.gitlab4j.api

Class GitLabApiForm

java.lang.Object

javax.ws.rs.core.Form

org.gitlab4j.api.GitLabApiForm

public class GitLabApiForm
extends javax.ws.rs.core.Form

This class extends the standard JAX-RS Form class to make it fluent.

Constructor Summary

Constructors

Constructor	Description
GitLabApiForm()
GitLabApiForm(int page, int perPage)	Create a GitLabApiForm instance with the "page", and "per_page" parameters preset.
GitLabApiForm(javax.ws.rs.core.MultivaluedHashMap<String,String> map)

Method Summary

Modifier and Type	Method	Description
GitLabApiForm	withParam(String name, Object value)	Fluent method for adding query and form parameters to a get() or post() call.
GitLabApiForm	withParam(String name, Object value, boolean required)	Fluent method for adding query and form parameters to a get() or post() call.
GitLabApiForm	withParam(String name, Date date)	Fluent method for adding Date query and form parameters to a get() or post() call.
GitLabApiForm	withParam(String name, Date date, boolean required)	Fluent method for adding Date query and form parameters to a get() or post() call.
<T> GitLabApiForm	withParam(String name, List<T> values)	Fluent method for adding a List type query and form parameters to a get() or post() call.
<T> GitLabApiForm	withParam(String name, List<T> values, boolean required)	Fluent method for adding a List type query and form parameters to a get() or post() call.
GitLabApiForm	withParam(String name, Map<String,?> variables, boolean required)	Fluent method for adding an array of hash type query and form parameters to a get() or post() call.
GitLabApiForm	withParam(String name, AccessLevel level)	Fluent method for adding AccessLevel query and form parameters to a get() or post() call.
GitLabApiForm	withParam(String name, AccessLevel level, boolean required)	Fluent method for adding AccessLevel query and form parameters to a get() or post() call.
GitLabApiForm	withParam(List<Variable> variables)	Fluent method for adding a List<Variable> type query and form parameters to a get(), post(), or put() call.

Methods inherited from class javax.ws.rs.core.Form

asMap, param

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitLabApiForm

public GitLabApiForm()

GitLabApiForm

public GitLabApiForm(javax.ws.rs.core.MultivaluedHashMap<String,String> map)

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" parameter

perPage - the value for the "per_page" parameter

Method Detail

withParam

public GitLabApiForm withParam(String name,
                               Object value)
                        throws IllegalArgumentException

Fluent method for adding query and form parameters to a get() or post() call.

Parameters:

name - the name of the field/attribute to add

value - the value of the field/attribute to add

Returns:

this GitLabAPiForm instance

Throws:

IllegalArgumentException

withParam

public GitLabApiForm withParam(String name,
                               Date date)
                        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 add

date - 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 add

date - the value of the field/attribute to add

required - 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,
                               AccessLevel level)
                        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 add

level - 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 add

level - the value of the field/attribute to add

required - the field is required flag

Returns:

this GitLabAPiForm instance

Throws:

IllegalArgumentException - if a required parameter is null or empty

withParam

public <T> GitLabApiForm withParam(String name,
                                   List<T> values)

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 add

values - 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 add

values - a List containing the values of the field/attribute to add

required - 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 IllegalArgumentException

Fluent 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 add

variables - a Map containing array of hashes

required - 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 add

value - the value of the field/attribute to add

required - the field is required flag

Returns:

this GitLabAPiForm instance

Throws:

IllegalArgumentException - if a required parameter is null or empty

withParam

public GitLabApiForm withParam(List<Variable> variables)

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