Package com.spotify.github.v3.repos.requests

Class ImmutableFileCreate

java.lang.Object

com.spotify.github.v3.repos.requests.ImmutableFileCreate

All Implemented Interfaces:

FileCreate

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

Immutable implementation of FileCreate.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	branch()	The branch name.
static ImmutableFileCreate.Builder	builder()	Creates a builder for ImmutableFileCreate.
String	content()	The new file content, using Base64 encoding
static ImmutableFileCreate	copyOf(FileCreate instance)	Creates an immutable copy of a FileCreate value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableFileCreate that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: message, content, branch.
String	message()	The commit message
String	toString()	Prints the immutable value FileCreate with attribute values.
ImmutableFileCreate	withBranch(String value)	Copy the current immutable object by setting a value for the branch attribute.
ImmutableFileCreate	withContent(String value)	Copy the current immutable object by setting a value for the content attribute.
ImmutableFileCreate	withMessage(String value)	Copy the current immutable object by setting a value for the message attribute.

Methods inherited from class java.lang.Object

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

Method Detail

message

public String message()

The commit message

Specified by:

message in interface FileCreate

content

public String content()

The new file content, using Base64 encoding

Specified by:

content in interface FileCreate

branch

@Nullable
public String branch()

The branch name. Default: the repository’s default branch

Specified by:

branch in interface FileCreate

withMessage

public final ImmutableFileCreate withMessage(String value)

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

Parameters:

value - A new value for message

Returns:

A modified copy of the this object

withContent

public final ImmutableFileCreate withContent(String value)

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

Parameters:

value - A new value for content

Returns:

A modified copy of the this object

withBranch

public final ImmutableFileCreate withBranch(@Nullable
                                            String value)

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

Parameters:

value - A new value for branch (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 ImmutableFileCreate 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: message, content, branch.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value FileCreate with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableFileCreate copyOf(FileCreate instance)

Creates an immutable copy of a FileCreate 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 FileCreate instance

builder

public static ImmutableFileCreate.Builder builder()

Creates a builder for ImmutableFileCreate.

 ImmutableFileCreate.builder()
    .message(String) // required message
    .content(String) // required content
    .branch(String | null) // nullable branch
    .build();
 

Returns:

A new ImmutableFileCreate builder