Added some documentation and a getter
This commit is contained in:
parent
2606cd8811
commit
40d1279890
2 changed files with 47 additions and 22 deletions
|
|
@ -266,7 +266,7 @@ public final class FFmpegConstants {
|
||||||
g726le,
|
g726le,
|
||||||
/** ADPCM IMA QuickTime **/
|
/** ADPCM IMA QuickTime **/
|
||||||
adpcm_ima_qt,
|
adpcm_ima_qt,
|
||||||
/** ADPCM IMA Simon & Schuster Interactive **/
|
/** ADPCM IMA Simon and Schuster Interactive **/
|
||||||
adpcm_ima_ssi,
|
adpcm_ima_ssi,
|
||||||
/** ADPCM IMA WAV **/
|
/** ADPCM IMA WAV **/
|
||||||
adpcm_ima_wav,
|
adpcm_ima_wav,
|
||||||
|
|
|
||||||
|
|
@ -38,12 +38,47 @@ public class UserMessageManager implements Iterable<UserMessageManager.UserMessa
|
||||||
private List<UserMessage> messages = Collections.synchronizedList(new LinkedList<>());
|
private List<UserMessage> messages = Collections.synchronizedList(new LinkedList<>());
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param id is the id of the wanted message.
|
||||||
|
* @return a UserMessage object matching the ID or null if no message was found
|
||||||
|
*/
|
||||||
|
public UserMessage get(int id) {
|
||||||
|
for(UserMessage msg : messages) {
|
||||||
|
if (msg.getId() == id) {
|
||||||
|
return msg;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
public void add(UserMessage message) {
|
public void add(UserMessage message) {
|
||||||
messages.remove(message); // We don't want to flood the user with duplicate messages
|
messages.remove(message); // We don't want to flood the user with duplicate messages
|
||||||
messages.add(message);
|
messages.add(message);
|
||||||
logger.finer("Added new user message: " + message);
|
logger.finer("Added new user message: " + message);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Dismiss a specific message, should be connected to a user action.
|
||||||
|
*
|
||||||
|
* @param id is the id of the specific message.
|
||||||
|
*/
|
||||||
|
public void dismiss(int id) {
|
||||||
|
for (UserMessage message : messages) {
|
||||||
|
if (message.getId() == id)
|
||||||
|
message.dismiss();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method must be executed when a gui has been generated,
|
||||||
|
* it will decrees TTL of all messages by one.
|
||||||
|
*/
|
||||||
|
public void decreaseTTL() {
|
||||||
|
for (UserMessage message : messages) {
|
||||||
|
message.decreaseTTL();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return a list of all active messages
|
* @return a list of all active messages
|
||||||
*/
|
*/
|
||||||
|
|
@ -67,29 +102,10 @@ public class UserMessageManager implements Iterable<UserMessageManager.UserMessa
|
||||||
return getMessages().iterator();
|
return getMessages().iterator();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* This method must be executed when a gui has been generated,
|
|
||||||
* it will decrees TTL of all messages by one.
|
|
||||||
*/
|
|
||||||
public void decrementViewCount() {
|
|
||||||
for (UserMessage message : messages) {
|
|
||||||
message.decreaseTTL();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Dismiss a specific message, should be connected to a user action.
|
* Enum that defines the severity level of the message.
|
||||||
*
|
|
||||||
* @param id is the id of the specific message.
|
|
||||||
*/
|
*/
|
||||||
public void dismiss(int id) {
|
|
||||||
for (UserMessage message : messages) {
|
|
||||||
if (message.getId() == id)
|
|
||||||
message.dismiss();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public enum MessageLevel {
|
public enum MessageLevel {
|
||||||
ERROR,
|
ERROR,
|
||||||
WARNING,
|
WARNING,
|
||||||
|
|
@ -97,11 +113,17 @@ public class UserMessageManager implements Iterable<UserMessageManager.UserMessa
|
||||||
INFO
|
INFO
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Ennum specifying how long a message should be shown to a User.
|
||||||
|
*/
|
||||||
public enum MessageTTL {
|
public enum MessageTTL {
|
||||||
ONE_VIEW,
|
ONE_VIEW,
|
||||||
DISMISSED
|
DISMISSED
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data class containing information about a single message.
|
||||||
|
*/
|
||||||
public static class UserMessage {
|
public static class UserMessage {
|
||||||
private static int nextId = 0;
|
private static int nextId = 0;
|
||||||
|
|
||||||
|
|
@ -119,7 +141,10 @@ public class UserMessageManager implements Iterable<UserMessageManager.UserMessa
|
||||||
this(level, title, null, ttl);
|
this(level, title, null, ttl);
|
||||||
}
|
}
|
||||||
public UserMessage(MessageLevel level, String title, String description, MessageTTL ttl) {
|
public UserMessage(MessageLevel level, String title, String description, MessageTTL ttl) {
|
||||||
this.id = nextId++;
|
synchronized (this) {
|
||||||
|
this.id = nextId++;
|
||||||
|
}
|
||||||
|
|
||||||
this.level = level;
|
this.level = level;
|
||||||
this.title = title;
|
this.title = title;
|
||||||
this.description = description;
|
this.description = description;
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue