com.alpineclient.plugin.api.objects

Class ClientResource

java.lang.Object

com.alpineclient.plugin.api.objects.ClientResource

public final class ClientResource
extends java.lang.Object

Represents an image texture.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientResource.Type Represents where the client looks for a resource.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static @NotNull ClientResource	external(@NotNull java.lang.String value) Compiles an external resource.
@NotNull ClientResource.Type	getType() Get the type of the resource.
@NotNull java.lang.String	getValue() Get the value of the resource.
int	hashCode()
static @NotNull ClientResource	internal(@NotNull java.lang.String value) Compiles an internal resource.
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getType

@NotNull
public @NotNull ClientResource.Type getType()

Get the type of the resource.

Returns:

the ClientResource.Type

getValue

@NotNull
public @NotNull java.lang.String getValue()

Get the value of the resource.

For ClientResource.Type.INTERNAL this is a path, for ClientResource.Type.EXTERNAL this is a URL.

Returns:

the ClientResource.Type

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

internal

@NotNull
public static @NotNull ClientResource internal(@NotNull
                                                        @NotNull java.lang.String value)

Compiles an internal resource.

Parameters:

value - the local path to the resource

Returns:

the compiled resource

See Also:

ClientResource.Type.INTERNAL

external

@NotNull
public static @NotNull ClientResource external(@NotNull
                                                        @NotNull java.lang.String value)

Compiles an external resource.

Parameters:

value - the URL to the resource

Returns:

the compiled resource

See Also:

ClientResource.Type.EXTERNAL