Top Description Inners Fields Constructors Methods
org.springframework.core.metrics

pack-priv Class DefaultApplicationStartup

extends Object
implements ApplicationStartup
Class Inheritance
All Implemented Interfaces
org.springframework.core.metrics.ApplicationStartup
Imports
java.util.Collections, .Iterator, java.util.function.Supplier

Default "no op" ApplicationStartup implementation.

This variant is designed for minimal overhead and does not record events.

Author
Brian Clozel

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class

Field Summary

Modifier and TypeField and Description
private static final DefaultApplicationStartup.DefaultStartupStep

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public DefaultApplicationStartup.DefaultStartupStep
start(String
the step name
name
)

Implements org.springframework.core.metrics.ApplicationStartup.start.

Create a new step and marks its beginning.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_STARTUP_STEPback to summary
private static final DefaultApplicationStartup.DefaultStartupStep DEFAULT_STARTUP_STEP

Constructor Detail

DefaultApplicationStartupback to summary
pack-priv DefaultApplicationStartup()

Method Detail

startback to summary
public DefaultApplicationStartup.DefaultStartupStep start(String name)

Implements org.springframework.core.metrics.ApplicationStartup.start.

Doc from org.springframework.core.metrics.ApplicationStartup.start.

Create a new step and marks its beginning.

A step name describes the current action or phase. This technical name should be "." namespaced and can be reused to describe other instances of the same step during application startup.

Parameters
name:String

the step name

Annotations
@Override
org.springframework.core.metrics back to summary

pack-priv Class DefaultApplicationStartup.DefaultStartupStep

extends Object
implements StartupStep
Class Inheritance
  • java.lang.Object
  • org.springframework.core.metrics.DefaultApplicationStartup.DefaultStartupStep
All Implemented Interfaces
org.springframework.core.metrics.StartupStep

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class

Field Summary

Modifier and TypeField and Description
private final DefaultApplicationStartup.DefaultStartupStep.DefaultTags

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
end()

Implements org.springframework.core.metrics.StartupStep.end.

Record the state of the step and possibly other metrics like execution time.

public long
getId()

Implements org.springframework.core.metrics.StartupStep.getId.

Return the unique id for this step within the application startup.

public String
getName()

Implements org.springframework.core.metrics.StartupStep.getName.

Return the name of the startup step.

public Long
getParentId()

Implements org.springframework.core.metrics.StartupStep.getParentId.

Return, if available, the id of the parent step.

public StartupStep.Tags
getTags()

Implements org.springframework.core.metrics.StartupStep.getTags.

Return the Tag collection for this step.

public StartupStep
tag(String
tag key
key
,
String
tag value
value
)

Implements org.springframework.core.metrics.StartupStep.tag.

Add a Tag to the step.

public StartupStep
tag(String
tag key
key
,
Supplier<String>
Supplier for the tag value
value
)

Implements org.springframework.core.metrics.StartupStep.tag.

Add a Tag to the step.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

TAGSback to summary
private final DefaultApplicationStartup.DefaultStartupStep.DefaultTags TAGS

Constructor Detail

DefaultStartupStepback to summary
pack-priv DefaultStartupStep()

Method Detail

endback to summary
public void end()

Implements org.springframework.core.metrics.StartupStep.end.

Doc from org.springframework.core.metrics.StartupStep.end.

Record the state of the step and possibly other metrics like execution time.

Once ended, changes on the step state are not allowed.

Annotations
@Override
getIdback to summary
public long getId()

Implements org.springframework.core.metrics.StartupStep.getId.

Doc from org.springframework.core.metrics.StartupStep.getId.

Return the unique id for this step within the application startup.

Annotations
@Override
getNameback to summary
public String getName()

Implements org.springframework.core.metrics.StartupStep.getName.

Doc from org.springframework.core.metrics.StartupStep.getName.

Return the name of the startup step.

A step name describes the current action or phase. This technical name should be "." namespaced and can be reused to describe other instances of similar steps during application startup.

Annotations
@Override
getParentIdback to summary
public Long getParentId()

Implements org.springframework.core.metrics.StartupStep.getParentId.

Doc from org.springframework.core.metrics.StartupStep.getParentId.

Return, if available, the id of the parent step.

The parent step is the step that was started the most recently when the current step was created.

Annotations
@Override
getTagsback to summary
public StartupStep.Tags getTags()

Implements org.springframework.core.metrics.StartupStep.getTags.

Doc from org.springframework.core.metrics.StartupStep.getTags.

Return the Tag collection for this step.

Annotations
@Override
tagback to summary
public StartupStep tag(String key, String value)

Implements org.springframework.core.metrics.StartupStep.tag.

Doc from org.springframework.core.metrics.StartupStep.tag.

Add a Tag to the step.

Parameters
key:String

tag key

value:String

tag value

Annotations
@Override
tagback to summary
public StartupStep tag(String key, Supplier<String> value)

Implements org.springframework.core.metrics.StartupStep.tag.

Doc from org.springframework.core.metrics.StartupStep.tag.

Add a Tag to the step.

Parameters
key:String

tag key

value:Supplier<String>

Supplier for the tag value

Annotations
@Override
org.springframework.core.metrics back to summary

pack-priv Class DefaultApplicationStartup.DefaultStartupStep.DefaultTags

extends Object
implements Tags
Class Inheritance
  • java.lang.Object
  • org.springframework.core.metrics.DefaultApplicationStartup.DefaultStartupStep.DefaultTags
All Implemented Interfaces
org.springframework.core.metrics.StartupStep.Tags, java.lang.Iterable

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public Iterator<StartupStep.Tag>
iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

DefaultTagsback to summary
pack-priv DefaultTags()

Method Detail

iteratorback to summary
public Iterator<StartupStep.Tag> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<StartupStep.Tag>

an Iterator.

Annotations
@Override