Package org.kingdoms.constants.group.flag

Class URLGroupBanner

java.lang.Object

org.kingdoms.constants.group.flag.URLGroupBanner

All Implemented Interfaces:

GroupBanner, org.kingdoms.constants.namespace.Namespaced, org.kingdoms.data.Deserializable, org.kingdoms.data.Serializable, org.kingdoms.locale.provider.CascadingMessageContextProvider, org.kingdoms.locale.provider.MessageContextProvider

public final class URLGroupBanner
extends Object
implements GroupBanner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	URLGroupBanner.Provider

Nested classes/interfaces inherited from interface org.kingdoms.constants.group.flag.GroupBanner

GroupBanner.PreferredMethod

Field Summary

Fields

Modifier and Type	Field	Description
static final GroupBannerProvider<URLGroupBanner>	PROVIDER

Constructor Summary

Constructors

Constructor	Description
URLGroupBanner()

Method Summary

Modifier and Type	Method	Description
void	addMessageContextEdits(@NotNull MessagePlaceholderProvider context)
BufferedImage	asImage()
Messenger	description()
void	deserialize(@NotNull DeserializationContext<org.kingdoms.data.database.dataprovider.SectionableDataGetter> context)
Dimension	getImageSize()
GroupBanner.PreferredMethod	getPreferredMethod()
GroupBannerProvider<URLGroupBanner>	getProvider()
void	serialize(@NotNull SerializationContext<org.kingdoms.data.database.dataprovider.SectionableDataSetter> context)
void	setUrl(URL url)
URL	urlOrCreate(Path path)	If this banner is saved in form of an image, a URL can be provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kingdoms.locale.provider.CascadingMessageContextProvider

getMessageContext

Methods inherited from interface org.kingdoms.constants.group.flag.GroupBanner

createItem, getNamespace

Field Details

PROVIDER

public static final GroupBannerProvider<URLGroupBanner> PROVIDER

Constructor Details

URLGroupBanner

public URLGroupBanner()

Method Details

setUrl

public void setUrl(URL url)

getPreferredMethod

public GroupBanner.PreferredMethod getPreferredMethod()

Specified by:

getPreferredMethod in interface GroupBanner

description

public Messenger description()

Specified by:

description in interface GroupBanner

asImage

public BufferedImage asImage()

Specified by:

asImage in interface GroupBanner

getImageSize

@Nullable
public Dimension getImageSize()

Specified by:

getImageSize in interface GroupBanner

urlOrCreate

public URL urlOrCreate(Path path)

Description copied from interface: GroupBanner

If this banner is saved in form of an image, a URL can be provided. This could be a file or even a link to a direct image file (PNG, JPEG, etc...) from a website.

Specified by:

urlOrCreate in interface GroupBanner

Parameters:

path - The path to generate the image to if it doesn't exist in a form of URL.

getProvider

public GroupBannerProvider<URLGroupBanner> getProvider()

Specified by:

getProvider in interface GroupBanner

deserialize

public void deserialize(@NotNull
 @NotNull DeserializationContext<org.kingdoms.data.database.dataprovider.SectionableDataGetter> context)

Specified by:

deserialize in interface org.kingdoms.data.Deserializable

addMessageContextEdits

public void addMessageContextEdits(@NotNull
 @NotNull MessagePlaceholderProvider context)

Specified by:

addMessageContextEdits in interface org.kingdoms.locale.provider.CascadingMessageContextProvider

serialize

public void serialize(@NotNull
 @NotNull SerializationContext<org.kingdoms.data.database.dataprovider.SectionableDataSetter> context)

Specified by:

serialize in interface GroupBanner

Specified by:

serialize in interface org.kingdoms.data.Serializable