FilterResults

java.lang.Object

org.deltava.discord.FilterResults

class FilterResults extends Object

A bean to store Discord content filter results.

Since:: 11.0
Version:: 11.0
Author:: Luke

Constructor Summary

Constructors

Constructor

Description

FilterResults()
Method Summary

Modifier and Type

Method

Description

void

add(String flagged)

Adds a flagged key word.

Collection<String>

getFlaggedResults()

Returns the flagged key words.

boolean

isOK()

Returns if the filter results detected no key words.

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

Constructor Details
- FilterResults
  
  FilterResults()
Method Details
- isOK
  
  public boolean isOK()
  
  Returns if the filter results detected no key words.
  
  Returns:
  
  TRUE if no flagged key words were detected, otherwise FALSE
- add
  
  public void add(String flagged)
  
  Adds a flagged key word.
  
  Parameters:
  
  flagged - the key word
- getFlaggedResults
  
  public Collection<String> getFlaggedResults()
  
  Returns the flagged key words.
  
  Returns:
  
  a Collection of flagged key words