@PublicApi public interface

BackingPropertySetManager

com.atlassian.jira.config.properties.BackingPropertySetManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

The PropertySet that backs the PropertiesSet needs to be Switchable - to allow the PicoContainer to manage this switching via ComponentAdapters we need an interface

Summary

Public Methods
Supplier<? extends PropertySet> getPropertySetSupplier()
void refresh()
refresh the underlying property set - this can also cause properties to be lost if the PropertySet has not been written to a backing store
void switchBackingStore()
If the backing property set supports switching to different backing storage, then switch - otherwise noop For now the switch is one way

Public Methods

public Supplier<? extends PropertySet> getPropertySetSupplier ()

Returns
  • the Supplier that references the underlying property set

public void refresh ()

refresh the underlying property set - this can also cause properties to be lost if the PropertySet has not been written to a backing store

public void switchBackingStore ()

If the backing property set supports switching to different backing storage, then switch - otherwise noop For now the switch is one way