org.apache.archiva.policies

Class AbstractPolicy

java.lang.Object

org.apache.archiva.policies.AbstractPolicy

All Implemented Interfaces:

Policy

Direct Known Subclasses:

AbstractUpdatePolicy, CachedFailuresPolicy, ChecksumPolicy, PropagateErrorsDownloadPolicy, PropagateErrorsOnUpdateDownloadPolicy

public abstract class AbstractPolicy
extends Object
implements Policy

Abstract policy class that handles the name and description loading with message bundles. The prefix for the keys is normally:

• Policies: POLICY-ID.policy.
• Options: POLICY-ID.option.

This prefix can be changed by subclasses. For each policy and each option there must exist a name and description entry in the message bundle.

Field Summary

Fields inherited from interface org.apache.archiva.policies.Policy

RESOURCE_BUNDLE

Constructor Summary

Constructors

Constructor and Description
AbstractPolicy()

Method Summary

Modifier and Type	Method and Description
String	getDescription(Locale locale) Return a description of the policy.
String	getName() Get the display name for this policy.
String	getName(Locale locale) Get the policy name in the language of the given locale.
String	getOptionDescription(Locale locale, PolicyOption option) Returns a description for the given option.
String	getOptionName(Locale locale, PolicyOption option) Returns a name for the given option.
protected String	getOptionPrefix()
protected String	getPolicyPrefix()
void	setOptionPrefix(String optionPrefix)
protected void	setPolicyPrefix(String policyPrefix)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.archiva.policies.Policy

getDefaultOption, getId, getOptions

Constructor Detail

AbstractPolicy

public AbstractPolicy()

Method Detail

getPolicyPrefix

protected String getPolicyPrefix()

getOptionPrefix

protected String getOptionPrefix()

setPolicyPrefix

protected void setPolicyPrefix(String policyPrefix)

setOptionPrefix

public void setOptionPrefix(String optionPrefix)

getName

public String getName()

Description copied from interface: Policy

Get the display name for this policy.

Specified by:

getName in interface Policy

Returns:

the name for this policy

getName

public String getName(Locale locale)

Description copied from interface: Policy

Get the policy name in the language of the given locale.

Specified by:

getName in interface Policy

Parameters:

locale - The locale

Returns:

The policy name

getDescription

public String getDescription(Locale locale)

Description copied from interface: Policy

Return a description of the policy.

Specified by:

getDescription in interface Policy

Parameters:

locale - The language

Returns:

The description

getOptionDescription

public String getOptionDescription(Locale locale,
                                   PolicyOption option)

Description copied from interface: Policy

Returns a description for the given option.

Specified by:

getOptionDescription in interface Policy

Parameters:

locale - The locale for the description.

option - The option to ask the description for.

Returns:

A description of the option in the requested language.

getOptionName

public String getOptionName(Locale locale,
                            PolicyOption option)

Description copied from interface: Policy

Returns a name for the given option.

Specified by:

getOptionName in interface Policy

Parameters:

locale - The locale for the name

option - The option identifier

Returns:

A name in the requested language.