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

Class ImmutableFileUpdate

java.lang.Object

com.spotify.github.v3.repos.requests.ImmutableFileUpdate

All Implemented Interfaces:

FileUpdate

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

Immutable implementation of FileUpdate.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

content

public String content()

The new file content, using Base64 encoding

Specified by:

content in interface FileUpdate

sha

public String sha()

The SHA of the file being replaced.

Specified by:

sha in interface FileUpdate

branch

@Nullable
public String branch()

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

Specified by:

branch in interface FileUpdate

withMessage

public final ImmutableFileUpdate 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 ImmutableFileUpdate 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

withSha

public final ImmutableFileUpdate withSha(String value)

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

Parameters:

value - A new value for sha

Returns:

A modified copy of the this object

withBranch

public final ImmutableFileUpdate 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 ImmutableFileUpdate 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, sha, branch.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value FileUpdate with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableFileUpdate copyOf(FileUpdate instance)

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

builder

public static ImmutableFileUpdate.Builder builder()

Creates a builder for ImmutableFileUpdate.

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

Returns:

A new ImmutableFileUpdate builder