de.marcely.bedwars.api.message.DefaultMessageMappings

All Implemented Interfaces:: Map<String,String>

public final class DefaultMessageMappings extends Object implements Map<String,String>

Contains a collection of messages that'll be used when the user tries to obtain a message from his messages file that is however not present.

This class is helpful for plugins that want to retain the users ability to customize the message. You may directly link it to your internal messages.yml file making it easier using loadInternalYAML(Plugin, InputStream).

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K extends Object,V extends Object>
Constructor Summary

Constructors

Constructor

Description

DefaultMessageMappings(Plugin plugin)
Method Summary

Modifier and Type

Method

Description

void

clear()

boolean

containsKey(Object key)

boolean

containsValue(Object value)

@NotNull Set<Map.Entry<String,String>>

entrySet()

String

get(Object key)

Plugin

getPlugin()

Returns the plugin that has constructed this instance.

boolean

isEmpty()

@NotNull Set<String>

keySet()

static DefaultMessageMappings

loadInternalYAML(Plugin plugin, InputStream stream)

Tries to load the YAML file as a language file.

@Nullable String

put(String key, String value)

void

putAll(@NotNull Map<? extends String,? extends String> m)

String

remove(Object key)

int

size()

@NotNull Collection<String>

values()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Details
- DefaultMessageMappings
  
  public DefaultMessageMappings(Plugin plugin)
Method Details
- getPlugin
  
  public Plugin getPlugin()
  
  Returns the plugin that has constructed this instance.
  
  Returns:
  
  The plugin behind these mappings
- size
  
  public int size()
  
  Specified by:
  
  size in interface Map<String,String>
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface Map<String,String>
- containsKey
  
  public boolean containsKey(Object key)
  
  Specified by:
  
  containsKey in interface Map<String,String>
- containsValue
  
  public boolean containsValue(Object value)
  
  Specified by:
  
  containsValue in interface Map<String,String>
- get
  
  public String get(Object key)
  
  Specified by:
  
  get in interface Map<String,String>
- put
  
  @Nullable public @Nullable String put(String key, String value)
  
  Specified by:
  
  put in interface Map<String,String>
- remove
  
  public String remove(Object key)
  
  Specified by:
  
  remove in interface Map<String,String>
- putAll
  
  public void putAll(@NotNull @NotNull Map<? extends String,? extends String> m)
  
  Specified by:
  
  putAll in interface Map<String,String>
- clear
  
  public void clear()
  
  Specified by:
  
  clear in interface Map<String,String>
- keySet
  
  @NotNull public @NotNull Set<String> keySet()
  
  Specified by:
  
  keySet in interface Map<String,String>
- values
  
  @NotNull public @NotNull Collection<String> values()
  
  Specified by:
  
  values in interface Map<String,String>
- entrySet
  
  @NotNull public @NotNull Set<Map.Entry<String,String>> entrySet()
  
  Specified by:
  
  entrySet in interface Map<String,String>
- loadInternalYAML
  
  public static DefaultMessageMappings loadInternalYAML(Plugin plugin, InputStream stream) throws IOException
  
  Tries to load the YAML file as a language file.
  Automatically closes the stream.
  
  Parameters:
  
  stream - The stream from which shall be read
  
  plugin - The plugin that wants them to get read
  
  Returns:
  
  The read mappings
  
  Throws:
  
  IOException - Might fail to load it

Class DefaultMessageMappings

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Details

DefaultMessageMappings

Method Details

getPlugin

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

loadInternalYAML