Package org.gitlab4j.models

Class GitLabForm

java.lang.Object

org.gitlab4j.models.GitLabForm

public class GitLabForm
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
GitLabForm()
GitLabForm(int page, int perPage)	Create a GitLabApiForm instance with the "page", and "per_page" parameters preset.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	getFormValues()
GitLabForm	withParam(java.lang.String name, java.lang.Object value)	Fluent method for adding query and form parameters to a get() or post() call.
GitLabForm	withParam(java.lang.String name, java.lang.Object value, boolean required)	Fluent method for adding query and form parameters to a get() or post() call.
GitLabForm	withParam(java.lang.String name, java.util.Date date)	Fluent method for adding Date query and form parameters to a get() or post() call.
GitLabForm	withParam(java.lang.String name, java.util.Date date, boolean required)	Fluent method for adding Date query and form parameters to a get() or post() call.
<T> GitLabForm	withParam(java.lang.String name, java.util.List<T> values)	Fluent method for adding a List type query and form parameters to a get() or post() call.
<T> GitLabForm	withParam(java.lang.String name, java.util.List<T> values, boolean required)	Fluent method for adding a List type query and form parameters to a get() or post() call.
GitLabForm	withParam(java.lang.String name, java.util.Map<java.lang.String,?> variables, boolean required)	Fluent method for adding an array of hash type query and form parameters to a get() or post() call.
GitLabForm	withParam(java.lang.String name, AccessLevel level)	Fluent method for adding AccessLevel query and form parameters to a get() or post() call.
GitLabForm	withParam(java.lang.String name, AccessLevel level, boolean required)	Fluent method for adding AccessLevel query and form parameters to a get() or post() call.
GitLabForm	withParam(java.util.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 java.lang.Object

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

Constructor Detail

GitLabForm

public GitLabForm()

GitLabForm

public GitLabForm(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 GitLabForm withParam(java.lang.String name,
                            java.lang.Object value)
                     throws java.lang.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:

java.lang.IllegalArgumentException

withParam

public GitLabForm withParam(java.lang.String name,
                            java.util.Date date)
                     throws java.lang.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:

java.lang.IllegalArgumentException

withParam

public GitLabForm withParam(java.lang.String name,
                            java.util.Date date,
                            boolean required)
                     throws java.lang.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:

java.lang.IllegalArgumentException - if a required parameter is null or empty

withParam

public GitLabForm withParam(java.lang.String name,
                            AccessLevel level)
                     throws java.lang.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:

java.lang.IllegalArgumentException

withParam

public GitLabForm withParam(java.lang.String name,
                            AccessLevel level,
                            boolean required)
                     throws java.lang.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:

java.lang.IllegalArgumentException - if a required parameter is null or empty

withParam

public <T> GitLabForm withParam(java.lang.String name,
                                java.util.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> GitLabForm withParam(java.lang.String name,
                                java.util.List<T> values,
                                boolean required)
                         throws java.lang.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:

java.lang.IllegalArgumentException - if a required parameter is null or empty

withParam

public GitLabForm withParam(java.lang.String name,
                            java.util.Map<java.lang.String,?> variables,
                            boolean required)
                     throws java.lang.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:

java.lang.IllegalArgumentException - if a required parameter is null or empty

withParam

public GitLabForm withParam(java.lang.String name,
                            java.lang.Object value,
                            boolean required)
                     throws java.lang.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:

java.lang.IllegalArgumentException - if a required parameter is null or empty

withParam

public GitLabForm withParam(java.util.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

getFormValues

public java.util.Map<java.lang.String,java.lang.String> getFormValues()