Package com.spotify.github.v3.prs.requests

Class ImmutablePullRequestCreate

java.lang.Object

com.spotify.github.v3.prs.requests.ImmutablePullRequestCreate

All Implemented Interfaces:

PullRequestCreate

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutablePullRequestCreate
extends Object
implements PullRequestCreate

Immutable implementation of PullRequestCreate.

Use the builder to create immutable instances: ImmutablePullRequestCreate.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutablePullRequestCreate.Builder	Builds instances of type ImmutablePullRequestCreate.

Method Summary

Modifier and Type	Method	Description
String	base()	The name of the branch you want your changes pulled into.
Optional<String>	body()	The contents of the pull request.
static ImmutablePullRequestCreate.Builder	builder()	Creates a builder for ImmutablePullRequestCreate.
static ImmutablePullRequestCreate	copyOf(PullRequestCreate instance)	Creates an immutable copy of a PullRequestCreate value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutablePullRequestCreate that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: title, body, head, base.
String	head()	The name of the branch where your changes are implemented.
String	title()	The title of the pull request.
String	toString()	Prints the immutable value PullRequestCreate with attribute values.
ImmutablePullRequestCreate	withBase(String value)	Copy the current immutable object by setting a value for the base attribute.
ImmutablePullRequestCreate	withBody(String value)	Copy the current immutable object by setting a present value for the optional body attribute.
ImmutablePullRequestCreate	withBody(Optional<String> optional)	Copy the current immutable object by setting an optional value for the body attribute.
ImmutablePullRequestCreate	withHead(String value)	Copy the current immutable object by setting a value for the head attribute.
ImmutablePullRequestCreate	withTitle(String value)	Copy the current immutable object by setting a value for the title attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

title

@Nullable
public String title()

The title of the pull request.

Specified by:

title in interface PullRequestCreate

body

public Optional<String> body()

The contents of the pull request.

Specified by:

body in interface PullRequestCreate

head

@Nullable
public String head()

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

Specified by:

head in interface PullRequestCreate

base

@Nullable
public String base()

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

Specified by:

base in interface PullRequestCreate

withTitle

public final ImmutablePullRequestCreate withTitle(@Nullable
                                                  String value)

Copy the current immutable object by setting a value for the title attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for title (can be null)

Returns:

A modified copy of the this object

withBody

public final ImmutablePullRequestCreate withBody(String value)

Copy the current immutable object by setting a present value for the optional body attribute.

Parameters:

value - The value for body

Returns:

A modified copy of this object

withBody

public final ImmutablePullRequestCreate withBody(Optional<String> optional)

Copy the current immutable object by setting an optional value for the body attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.

Parameters:

optional - A value for body

Returns:

A modified copy of this object

withHead

public final ImmutablePullRequestCreate withHead(@Nullable
                                                 String value)

Copy the current immutable object by setting a value for the head attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for head (can be null)

Returns:

A modified copy of the this object

withBase

public final ImmutablePullRequestCreate withBase(@Nullable
                                                 String value)

Copy the current immutable object by setting a value for the base attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for base (can be null)

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutablePullRequestCreate that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: title, body, head, base.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value PullRequestCreate with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutablePullRequestCreate copyOf(PullRequestCreate instance)

Creates an immutable copy of a PullRequestCreate value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable PullRequestCreate instance

builder

public static ImmutablePullRequestCreate.Builder builder()

Creates a builder for ImmutablePullRequestCreate.

 ImmutablePullRequestCreate.builder()
    .title(String | null) // nullable title
    .body(String) // optional body
    .head(String | null) // nullable head
    .base(String | null) // nullable base
    .build();
 

Returns:

A new ImmutablePullRequestCreate builder