org.jomc.modlet

Interface ModletProvider

All Known Implementing Classes:

DefaultModletProvider

public interface ModletProvider

Modlet provider interface.

Version:

$JOMC: ModletProvider.java 5101 2016-04-04 18:52:11Z schulte $

Author:

Christian Schulte

See Also:

ModelContext.findModlets(org.jomc.modlet.Modlets)

Method Summary

Methods

Modifier and Type	Method and Description
Modlets	findModlets(ModelContext context) Deprecated. As of JOMC 1.6, replaced by findModlets(org.jomc.modlet.ModelContext, org.jomc.modlet.Modlets). This method will be removed in JOMC 2.0.
Modlets	findModlets(ModelContext context, Modlets modlets) Searches a given context for Modlets.
int	getOrdinal() Gets the ordinal number of the provider.

Method Detail

getOrdinal

int getOrdinal()

Gets the ordinal number of the provider.

Returns:

The ordinal number of the provider.

Since:

1.6

findModlets

@Deprecated
Modlets findModlets(ModelContext context)
                    throws NullPointerException,
                           ModelException

Deprecated. As of JOMC 1.6, replaced by findModlets(org.jomc.modlet.ModelContext, org.jomc.modlet.Modlets). This method will be removed in JOMC 2.0.

Searches a given context for Modlets.

Parameters:

context - The context to search for Modlets.

Returns:

The Modlets found in the context or null, if no Modlets are found.

Throws:

NullPointerException - if context is null.

ModelException - if searching the context fails.

findModlets

Modlets findModlets(ModelContext context,
                  Modlets modlets)
                    throws NullPointerException,
                           ModelException

Searches a given context for Modlets.

Parameters:

context - The context to search for Modlets.

modlets - The Modlets currently being searched.

Returns:

The Modlets found in the context or null, if no Modlets are found.

Throws:

NullPointerException - if context or modlets is null.

ModelException - if searching the context fails.

Since:

1.6