Package org.jvnet.hk2.config.types

Interface PropertyBag

All Known Subinterfaces:

AccessLog, AdminObjectResource, AdminService, Application, AuditModule, AuthorizationProviderConfig, AuthRealm, AvailabilityService, Cluster, ConcurrencyResource, Config, ConnectionPoolChecker, ConnectorConnectionPool, ConnectorResource, ConnectorService, ContextService, CpuUsageChecker, CustomResource, DasConfig, DeploymentGroup, DiagnosticService, Domain, EjbContainer, EjbContainerAvailability, EjbTimerService, Engine, ExternalJndiResource, FileCache, GarbageCollectorChecker, GroupManagementService, HeapMemoryUsageChecker, Http, HttpRedirect, HttpService, IiopListener, JaccProvider, JavaConfig, JdbcConnectionPool, JdbcResource, JmsAvailability, JmsHost, JmsService, JmxConnector, LbConfig, ListenerConfig, LoadBalancer, LoginModuleConfig, MachineMemoryUsageChecker, MailResource, ManagedExecutorService, ManagedExecutorServiceBase, ManagedJobConfig, ManagedScheduledExecutorService, ManagedThreadFactory, ManagerProperties, Mbean, MdbContainer, Module, ModuleLogLevels, ModuleMonitoringLevels, MonitoringService, NetworkConfig, NetworkListener, NetworkListeners, NodeAgent, Orb, PersistenceManagerFactoryResource, PortUnification, Profiler, Protocol, ProtocolChain, ProtocolChainInstanceHandler, ProtocolFilter, ProtocolFinder, Protocols, ProviderConfig, ResourceAdapterConfig, RoleMappingProviderConfig, SecurityService, SelectionKeyHandler, Server, SessionProperties, Ssl, StoreProperties, ThreadPool, ThresholdDiagnosticsChecker, TransactionService, Transport, Transports, VirtualServer, WebContainer, WebContainerAvailability

All Known Implementing Classes:

DummyNetworkListener, JmsHostWrapper

@Customizer(PropertyBagCustomizer.class)
public interface PropertyBag

Base interface for those configuration objects that has nested <property> elements.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PropertyBag.Duck

Method Summary

Modifier and Type	Method	Description
Property	addProperty(Property property)
List<Property>	getProperty()	Gets the value of the property property.
Property	getProperty(String name)
String	getPropertyValue(String name)	Returns a property value if the bean has properties and one of its properties name is equal to the one passed.
String	getPropertyValue(String name, String defaultValue)	Returns a property value if the bean has properties and one of its properties name is equal to the one passed.
Property	lookupProperty(String name)
Property	removeProperty(String name)
Property	removeProperty(Property removeMe)

Method Detail

getProperty

List<Property> getProperty()

Gets the value of the property property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the property property.

For example, to add a new item, do as follows:

    getProperty().add(newItem);
 

Objects of the following type(s) are allowed in the list Property

Returns:

the property list

addProperty

Property addProperty(Property property)

lookupProperty

Property lookupProperty(String name)

removeProperty

Property removeProperty(String name)

removeProperty

Property removeProperty(Property removeMe)

getProperty

@Customize
@DuckTyped
Property getProperty(String name)

getPropertyValue

@Customize
@DuckTyped
String getPropertyValue(String name)

Returns a property value if the bean has properties and one of its properties name is equal to the one passed.

Parameters:

name - the property name requested

Returns:

the property value or null if not found

getPropertyValue

@Customize
@DuckTyped
String getPropertyValue(String name,
                        String defaultValue)

Returns a property value if the bean has properties and one of its properties name is equal to the one passed. Otherwise return the default value.

Parameters:

name - the property name requested

defaultValue - is the default value to return in case the property of that name does not exist in this bag

Returns:

the property value