Class Growl

java.lang.Object
  Growl

public class Growl

extends java.lang.Object

A class that encapsulates the "work" of talking to growl

Field Summary

static java.lang.String	GROWL_APP_ICON
static java.lang.String	GROWL_APP_NAME
static java.lang.String	GROWL_APP_REGISTRATION
static java.lang.String	GROWL_NOTIFICATION
static java.lang.String	GROWL_NOTIFICATION_APP_ICON
static java.lang.String	GROWL_NOTIFICATION_DESCRIPTION
static java.lang.String	GROWL_NOTIFICATION_ICON
static java.lang.String	GROWL_NOTIFICATION_NAME
static java.lang.String	GROWL_NOTIFICATION_TITLE
static java.lang.String	GROWL_NOTIFICATIONS_ALL
static java.lang.String	GROWL_NOTIFICATIONS_DEFAULT

Method Summary

NSArray	allowedNotifications() Accessor for the Array of allowed Notifications returned an NSArray
java.lang.String	applicationName() Accessor for The currently set "Application" Name
NSArray	defaultNotifications() Accessor for the Array of default Notifications returned as an NSArray
void	notifyGrowlOf(java.lang.String inNotificationName, NSData inIconData, java.lang.String inTitle, java.lang.String inDescription, NSDictionary inExtraInfo) The fun part is actually sending those notifications we worked so hard for so here we let growl know about things we think the user would like, and growl decides if that is the case.
void	notifyGrowlOf(java.lang.String inNotificationName, java.lang.String inTitle, java.lang.String inDescription) Convenienve method that defers to notifyGrowlOf( String inNotificationName, NSData inIconData, String inTitle, String inDescription, NSDictionary inExtraInfo ) with null passed for icon and extraInfo arguments
void	notifyGrowlOf(java.lang.String inNotificationName, java.lang.String inImagePath, java.lang.String inTitle, java.lang.String inDescription) Convenienve method that defers to notifyGrowlOf( String inNotificationName, NSData inIconData, String inTitle, String inDescription, NSDictionary inExtraInfo ) with null passed for extraInfo
boolean	register() Register all our notifications with Growl, this should only be called once
void	setAllowedNotifications(NSArray inAllNotes) Set the list of allowed Notifications
void	setApplicationName(java.lang.String inAppName) Sets The name of the Application talking to growl
void	setDefaultNotifications(NSArray inDefNotes) Set the list of Default Notfiications

Methods inherited from class java.lang.Object

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

Field Detail

GROWL_APP_REGISTRATION

public static final java.lang.String GROWL_APP_REGISTRATION

See Also:

Constant Field Values

GROWL_APP_NAME

public static final java.lang.String GROWL_APP_NAME

See Also:

Constant Field Values

GROWL_APP_ICON

public static final java.lang.String GROWL_APP_ICON

See Also:

Constant Field Values

GROWL_NOTIFICATIONS_DEFAULT

public static final java.lang.String GROWL_NOTIFICATIONS_DEFAULT

See Also:

Constant Field Values

GROWL_NOTIFICATIONS_ALL

public static final java.lang.String GROWL_NOTIFICATIONS_ALL

See Also:

Constant Field Values

GROWL_NOTIFICATION

public static final java.lang.String GROWL_NOTIFICATION

See Also:

Constant Field Values

GROWL_NOTIFICATION_NAME

public static final java.lang.String GROWL_NOTIFICATION_NAME

See Also:

Constant Field Values

GROWL_NOTIFICATION_TITLE

public static final java.lang.String GROWL_NOTIFICATION_TITLE

See Also:

Constant Field Values

GROWL_NOTIFICATION_DESCRIPTION

public static final java.lang.String GROWL_NOTIFICATION_DESCRIPTION

See Also:

Constant Field Values

GROWL_NOTIFICATION_ICON

public static final java.lang.String GROWL_NOTIFICATION_ICON

See Also:

Constant Field Values

GROWL_NOTIFICATION_APP_ICON

public static final java.lang.String GROWL_NOTIFICATION_APP_ICON

See Also:

Constant Field Values

Method Detail

register

public boolean register()

Register all our notifications with Growl, this should only be called once

notifyGrowlOf

public void notifyGrowlOf(java.lang.String inNotificationName,
                          NSData inIconData,
                          java.lang.String inTitle,
                          java.lang.String inDescription,
                          NSDictionary inExtraInfo)
                   throws java.lang.Exception

The fun part is actually sending those notifications we worked so hard for so here we let growl know about things we think the user would like, and growl decides if that is the case.

Parameters:

inNotificationName - - The name of one of the notifications we told growl about.

inIconData - - The NSData for the icon for this notification, can be null

inTitle - - The Title of our Notification as Growl will show it

inDescription - - The Description of our Notification as Growl will display it

Throws:

java.lang.Exception - When a notification is not known

notifyGrowlOf

public void notifyGrowlOf(java.lang.String inNotificationName,
                          java.lang.String inTitle,
                          java.lang.String inDescription)
                   throws java.lang.Exception

Convenienve method that defers to notifyGrowlOf( String inNotificationName, NSData inIconData, String inTitle, String inDescription, NSDictionary inExtraInfo ) with null passed for icon and extraInfo arguments

Parameters:

inNotificationName - - The name of one of the notifications we told growl about.

inTitle - - The Title of our Notification as Growl will show it

inDescription - - The Description of our Notification as Growl will display it

Throws:

java.lang.Exception - When a notification is not known

notifyGrowlOf

public void notifyGrowlOf(java.lang.String inNotificationName,
                          java.lang.String inImagePath,
                          java.lang.String inTitle,
                          java.lang.String inDescription)
                   throws java.lang.Exception

Convenienve method that defers to notifyGrowlOf( String inNotificationName, NSData inIconData, String inTitle, String inDescription, NSDictionary inExtraInfo ) with null passed for extraInfo

Parameters:

inNotificationName - - The name of one of the notifications we told growl about.

inImagePath - - Path to the image for this notification

inTitle - - The Title of our Notification as Growl will show it

inDescription - - The Description of our Notification as Growl will display it

Throws:

java.lang.Exception - When a notification is not known

applicationName

public java.lang.String applicationName()

Accessor for The currently set "Application" Name

allowedNotifications

public NSArray allowedNotifications()

Accessor for the Array of allowed Notifications returned an NSArray

defaultNotifications

public NSArray defaultNotifications()

Accessor for the Array of default Notifications returned as an NSArray

setApplicationName

public void setApplicationName(java.lang.String inAppName)

Sets The name of the Application talking to growl

Parameters:

inAppName - - The Application Name

setAllowedNotifications

public void setAllowedNotifications(NSArray inAllNotes)

Set the list of allowed Notifications

Parameters:

inAllNotes - - The array of allowed Notifications

setDefaultNotifications

public void setDefaultNotifications(NSArray inDefNotes)
                             throws java.lang.Exception

Set the list of Default Notfiications

Parameters:

inDefNotes - - The default Notifications

Throws:

java.lang.Exception - when an element of the array is not in the allowedNotifications