Package org.axonframework.common.infra

Class FilesystemStyleComponentDescriptor

java.lang.Object

org.axonframework.common.infra.FilesystemStyleComponentDescriptor

All Implemented Interfaces:

ComponentDescriptor

public class FilesystemStyleComponentDescriptor
extends Object
implements ComponentDescriptor

A ComponentDescriptor implementation inspired by filesystem structures. Components are represented as "directories" with properties as "files" and references as "symbolic links". This creates a clear hierarchical representation with explicit paths to show component relationships.

Each component is assigned a path in the virtual filesystem. References to components that have already been described are represented as symbolic links, indicated with the -> /path/to/component syntax, preventing infinite recursion in circular references.

Example output:

 /
 ├── systemComponent/
 │   ├── _ref: 123512
 │   ├── _type: EventProcessor
 │   ├── name: my-processor
 │   └── configuration/
 │       ├── _ref: 123513
 │       ├── _type: ProcessorConfiguration
 │       ├── batchSize: 100
 │       └── processor -> /systemComponent
 

Since:

5.0.0

Author:

Mateusz Nowak

Constructor Summary

Constructors

Constructor	Description
FilesystemStyleComponentDescriptor()	Constructs a new FilesystemComponentDescriptor as the root of the hierarchy.

Method Summary

Modifier and Type	Method	Description
String	describe()	Provides the description of this ComponentDescriptor.
void	describeProperty(String name, @Nullable Boolean value)	Describe the given value with this descriptor for the given name.
void	describeProperty(String name, @Nullable Long value)	Describe the given value with this descriptor for the given name.
void	describeProperty(String name, @Nullable Object object)	Describe the given object with this descriptor for the given name.
void	describeProperty(String name, @Nullable String value)	Describe the given value with this descriptor for the given name.
void	describeProperty(String name, @Nullable Collection<?> collection)	Describe the given collection with this descriptor for the given name.
void	describeProperty(String name, @Nullable Map<?,?> map)	Describe the given map with this descriptor for the given name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.common.infra.ComponentDescriptor

describeWrapperOf

Constructor Details

FilesystemStyleComponentDescriptor

public FilesystemStyleComponentDescriptor()

Constructs a new FilesystemComponentDescriptor as the root of the hierarchy.

Method Details

describeProperty

public void describeProperty(String name,
 @Nullable Object object)

Description copied from interface: ComponentDescriptor

Describe the given object with this descriptor for the given name.

If the object is a DescribableComponent, DescribableComponent.describeTo(ComponentDescriptor) is invoked with this descriptor.

Specified by:

describeProperty in interface ComponentDescriptor

Parameters:

name - The name for the object to describe.

object - The object to describe with this descriptor.

describeProperty

public void describeProperty(String name,
 @Nullable Collection<?> collection)

Description copied from interface: ComponentDescriptor

Describe the given collection with this descriptor for the given name.

If any item in the collection is a DescribableComponent, it will be processed as if ComponentDescriptor.describeProperty(String, Object) was invoked for that item, and DescribableComponent.describeTo(ComponentDescriptor) will be called on it.

The formatting of the collection typically takes a regular array structure.

Specified by:

describeProperty in interface ComponentDescriptor

Parameters:

name - The name for the collection to describe.

collection - The collection to describe with this descriptor.

describeProperty

public void describeProperty(String name,
 @Nullable Map<?,?> map)

Description copied from interface: ComponentDescriptor

Describe the given map with this descriptor for the given name.

If any value in the map is a DescribableComponent, it will be processed as if ComponentDescriptor.describeProperty(String, Object) was invoked for that value, and DescribableComponent.describeTo(ComponentDescriptor) will be called on it.

The formatting of the map typically takes a regular key-value structure based on the entries of the map.

Specified by:

describeProperty in interface ComponentDescriptor

Parameters:

name - The name for the map to describe.

map - The map to describe with this descriptor.

describeProperty

public void describeProperty(String name,
 @Nullable String value)

Description copied from interface: ComponentDescriptor

Describe the given value with this descriptor for the given name.

Specified by:

describeProperty in interface ComponentDescriptor

Parameters:

name - The name for the value to describe.

value - The value to describe with this descriptor.

describeProperty

public void describeProperty(String name,
 @Nullable Long value)

Description copied from interface: ComponentDescriptor

Describe the given value with this descriptor for the given name.

Specified by:

describeProperty in interface ComponentDescriptor

Parameters:

name - The name for the value to describe.

value - The value to describe with this descriptor.

describeProperty

public void describeProperty(String name,
 @Nullable Boolean value)

Description copied from interface: ComponentDescriptor

Describe the given value with this descriptor for the given name.

Specified by:

describeProperty in interface ComponentDescriptor

Parameters:

name - The name for the value to describe.

value - The value to describe with this descriptor.

describe

public String describe()

Description copied from interface: ComponentDescriptor

Provides the description of this ComponentDescriptor.

Specified by:

describe in interface ComponentDescriptor

Returns:

The description result of this ComponentDescriptor.