net.lapismc.lapisbans.api.punishments.core

Class PunishmentList

java.lang.Object

net.lapismc.lapisbans.api.punishments.core.PunishmentList

public class PunishmentList
extends Object

A class for storing a list of PunishmentInterface's. This is required because of the way the API is structured There is no need for the user of this API to use this class, it is simply used to make converting a list of punishments to a list of PunishmentInterface's easier

Constructor Summary

Constructors

Constructor and Description
PunishmentList() Setup the list

Method Summary

Modifier and Type	Method and Description
void	add(PunishmentInterface punishment) Add a PunishmentInterface to the list
void	addAll(Collection<PunishmentInterface> punishments) Add multiple vales at once
PunishmentInterface	get(Integer index) Get the punishment at any index
List<PunishmentInterface>	getAsList() Get the PunishmentInterface's currently stored as a List
void	remove(PunishmentInterface punishment) Remove a PunishmentInterface from the list
Integer	size() Get the number of items currently in the list

Methods inherited from class java.lang.Object

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

Constructor Detail

PunishmentList

public PunishmentList()

Setup the list

Method Detail

size

public Integer size()

Get the number of items currently in the list

Returns:

Returns the number of Punishments stored

get

public PunishmentInterface get(Integer index)

Get the punishment at any index

Parameters:

index - The index you wish to fetch

Returns:

Returns the PunishmentInterface at the index provided

add

public void add(PunishmentInterface punishment)

Add a PunishmentInterface to the list

Parameters:

punishment - The punishment you wish to add

addAll

public void addAll(Collection<PunishmentInterface> punishments)

Add multiple vales at once

Parameters:

punishments - The collection of PunishmentInterface's you wish to add

remove

public void remove(PunishmentInterface punishment)

Remove a PunishmentInterface from the list

Parameters:

punishment - the punishment you wish to remove

getAsList

public List<PunishmentInterface> getAsList()

Get the PunishmentInterface's currently stored as a List

Returns:

Returns a list of the currently stored punishments