io microsphere spring config env event PropertySourceChangedEvent

PropertySourceChangedEvent

Type: Class | Module: microsphere-spring-context | Package: io.microsphere.spring.config.env.event | Since: 1.0.0

Source: microsphere-spring-context/src/main/java/io/microsphere/spring/config/env/event/PropertySourceChangedEvent.java

Overview

Event raised when a PropertySource is added, removed, or replaced in the environment's property sources. This event extends ApplicationContextEvent, which means it is associated with an ApplicationContext.

Example Usage

`// Creating an ADDED event
PropertySourceChangedEvent addedEvent = PropertySourceChangedEvent.added(context, newPropertySource);

// Creating a REPLACED event
PropertySourceChangedEvent replacedEvent = PropertySourceChangedEvent.replaced(context, newPropertySource, oldPropertySource);

// Creating a REMOVED event
PropertySourceChangedEvent removedEvent = PropertySourceChangedEvent.removed(context, oldPropertySource);
`

Declaration

public class PropertySourceChangedEvent extends ApplicationContextEvent

Author: Mercy

Version Information

• Introduced in: 1.0.0
• Current Project Version: 0.2.27-SNAPSHOT

Version Compatibility

This component is tested and compatible with the following Java versions:

Java Version	Status
Java 17	✅ Compatible
Java 21	✅ Compatible
Java 25	✅ Compatible

Examples

// Creating an ADDED event
PropertySourceChangedEvent addedEvent = PropertySourceChangedEvent.added(context, newPropertySource);

// Creating a REPLACED event
PropertySourceChangedEvent replacedEvent = PropertySourceChangedEvent.replaced(context, newPropertySource, oldPropertySource);

// Creating a REMOVED event
PropertySourceChangedEvent removedEvent = PropertySourceChangedEvent.removed(context, oldPropertySource);

Method Examples

getNewPropertySource

PropertySourceChangedEvent event = new PropertySourceChangedEvent(
      context, PropertySourceChangedEvent.Kind.REPLACED, newPropertySource, oldPropertySource);
  assertEquals(PropertySourceChangedEvent.Kind.REPLACED, event.getKind());
  assertSame(newPropertySource, event.getNewPropertySource());
  assertSame(oldPropertySource, event.getOldPropertySource());

PropertySourceChangedEvent event = new PropertySourceChangedEvent(
      context, PropertySourceChangedEvent.Kind.ADDED, newPropertySource);
  assertEquals(PropertySourceChangedEvent.Kind.ADDED, event.getKind());
  assertSame(newPropertySource, event.getNewPropertySource());
  assertNull(event.getOldPropertySource());

Usage

Maven Dependency

Add the following dependency to your pom.xml:

<dependency>
    <groupId>io.github.microsphere-projects</groupId>
    <artifactId>microsphere-spring-context</artifactId>
    <version>${microsphere-spring.version}</version>
</dependency>

Tip: Use the BOM (microsphere-spring-dependencies) for consistent version management. See the Getting Started guide.

Import

import io.microsphere.spring.config.env.event.PropertySourceChangedEvent;

API Reference

Public Methods

Method	Description
getNewPropertySource	Constructs a new PropertySourceChangedEvent with the specified application context, kind,
getOldPropertySource
getKind
added	Create an Kind#ADDED added instance
replaced	Create an Kind#REPLACED replaced instance
removed	Create an Kind#REMOVED removed instance

Method Details

getNewPropertySource

public PropertySource getNewPropertySource()

Constructs a new PropertySourceChangedEvent with the specified application context, kind, new property source, and old property source.

Example Usage

`PropertySourceChangedEvent event = new PropertySourceChangedEvent(
      context, PropertySourceChangedEvent.Kind.REPLACED, newPropertySource, oldPropertySource);
  assertEquals(PropertySourceChangedEvent.Kind.REPLACED, event.getKind());
  assertSame(newPropertySource, event.getNewPropertySource());
  assertSame(oldPropertySource, event.getOldPropertySource());
`

See Also

• PropertySource
• ApplicationContextEvent

---

This documentation was auto-generated from the source code of microsphere-spring.