io.nats.client.api

Class ObjectLink

java.lang.Object

io.nats.client.api.ObjectLink

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

public class ObjectLink
extends java.lang.Object
implements io.nats.client.support.JsonSerializable

The ObjectLink is used to embed links to other objects.

Method Summary

Modifier and Type	Method and Description
static ObjectLink	bucket(@NonNull java.lang.String bucket) create a bucket link
boolean	equals(java.lang.Object o)
@NonNull java.lang.String	getBucket() Get the bucket the linked object is in
@Nullable java.lang.String	getObjectName() Get the name of the object for the link
int	hashCode()
boolean	isBucketLink() True if the object is a bucket to an object versus a link to a link
boolean	isObjectLink() True if the object is a link to an object versus a link to a bucket
static ObjectLink	object(java.lang.String bucket, java.lang.String objectName) create an object link
@NonNull java.lang.String	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.nats.client.support.JsonSerializable

serialize, toJsonValue

Method Detail

toJson

public @NonNull java.lang.String toJson()

Specified by:

toJson in interface io.nats.client.support.JsonSerializable

getBucket

public @NonNull java.lang.String getBucket()

Get the bucket the linked object is in

Returns:

the bucket name

getObjectName

public @Nullable java.lang.String getObjectName()

Get the name of the object for the link

Returns:

the object name

isObjectLink

public boolean isObjectLink()

True if the object is a link to an object versus a link to a bucket

Returns:

true if the object is a link

isBucketLink

public boolean isBucketLink()

True if the object is a bucket to an object versus a link to a link

Returns:

true if the object is a bucket

bucket

public static ObjectLink bucket(@NonNull java.lang.String bucket)

create a bucket link

Parameters:

bucket - the bucket name

Returns:

the ObjectLink

object

public static ObjectLink object(java.lang.String bucket,
                                java.lang.String objectName)

create an object link

Parameters:

bucket - the bucket the object is in

objectName - the object name

Returns:

the ObjectLink

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object