org.apache.cocoon.components.notification
Interface NotifyingBuilder

All Superinterfaces:

org.apache.avalon.framework.component.Component

All Known Implementing Classes:

DefaultNotifyingBuilder

public interface NotifyingBuilder

extends org.apache.avalon.framework.component.Component

Generates an Notifying representation of widely used objects.

Version:

CVS $Id: NotifyingBuilder.java,v 1.5.2.1 2002/07/15 14:52:59 cziegeler Exp $

Author:

Nicola Ken Barozzi

Field Summary

static java.lang.String

ROLE The role implemented by a NotifyingBuilder.

Method Summary

Notifying	build(java.lang.Object sender, java.lang.Object o) Builds a Notifying object (SimpleNotifyingObject in this case) that tries to explain what the Object o can reveal.
Notifying	build(java.lang.Object sender, java.lang.Object o, java.lang.String type, java.lang.String title, java.lang.String source, java.lang.String message, java.lang.String description, java.util.Map extra) Builds a Notifying object (SimpleNotifyingObject in this case) that explains a notification.

Field Detail

ROLE

public static final java.lang.String ROLE

The role implemented by a NotifyingBuilder.

Method Detail

build

public Notifying build(java.lang.Object sender,
                       java.lang.Object o)

Builds a Notifying object (SimpleNotifyingObject in this case) that tries to explain what the Object o can reveal.

Parameters:

sender - who sent this Object.

o - the object to use when building the SimpleNotifyingObject

Returns:

the Notifying Object that was build

See Also:

Notifying

build

public Notifying build(java.lang.Object sender,
                       java.lang.Object o,
                       java.lang.String type,
                       java.lang.String title,
                       java.lang.String source,
                       java.lang.String message,
                       java.lang.String description,
                       java.util.Map extra)

Builds a Notifying object (SimpleNotifyingObject in this case) that explains a notification.

Parameters:

sender - who sent this Object.

o - the object to use when building the SimpleNotifyingObject

type - see the Notifying apidocs

title - see the Notifying apidocs

source - see the Notifying apidocs

message - see the Notifying apidocs

description - see the Notifying apidocs

extra - see the Notifying apidocs

Returns:

the Notifying Object that was build

See Also:

Notifying