A C G H I N P R S T V _

A

addSubPrinter(PunchPrinter) - Method in class com.github.punch.api.printer.PunchPrinter

Add a sub printer.

ansi() - Method in enum com.github.punch.api.printer.PunchPrinter.Color

C

com.github.punch.api.exceptions - package com.github.punch.api.exceptions

com.github.punch.api.node - package com.github.punch.api.node

Copyright © 2016-2021 Thales Services Numériques Licensed under the Thales Inner Source Software License: Version 1.2, InnerOpen - Distribution Controlled You may not use this file except in compliance with the License.

com.github.punch.api.printer - package com.github.punch.api.printer

com.github.punch.api.validations - package com.github.punch.api.validations

create() - Static method in class com.github.punch.api.printer.PunchPrinter

Instance provider

G

getFieldsAsList() - Method in interface com.github.punch.api.node.StreamDeclaration

getFieldsAsString() - Method in interface com.github.punch.api.node.StreamDeclaration

getMessage() - Method in exception com.github.punch.api.exceptions.PunchClassNotFoundException

getMessage() - Method in exception com.github.punch.api.exceptions.PunchlineException

getMessage() - Method in exception com.github.punch.api.exceptions.PunchNodeException

getMessage() - Method in exception com.github.punch.api.exceptions.PunchNodeSettingException

getMessage() - Method in exception com.github.punch.api.exceptions.PunchSubscriptionNotFoundException

getNodeName() - Method in exception com.github.punch.api.exceptions.PunchNodeException

getPublishedStreams() - Method in interface com.github.punch.api.node.NodeSettings

getReservedStreams() - Static method in interface com.github.punch.api.node.IReservedStreams

getSettings() - Method in interface com.github.punch.api.node.NodeSettings

Node settings

getStreamId() - Method in interface com.github.punch.api.node.StreamDeclaration

getSubscriptedComponentName() - Method in exception com.github.punch.api.exceptions.PunchSubscriptionNotFoundException

getSubscriptedStreamName() - Method in exception com.github.punch.api.exceptions.PunchSubscriptionNotFoundException

getUndefinedClassName() - Method in exception com.github.punch.api.exceptions.PunchClassNotFoundException

H

Host - Annotation Type in com.github.punch.api.validations

HostValidator - Class in com.github.punch.api.validations

This validator makes sure that a String is in <hostname>:<port> format.

HostValidator() - Constructor for class com.github.punch.api.validations.HostValidator

I

IReservedStreams - Interface in com.github.punch.api.node

Reserved punchplatform streams.

isReservedStream(String) - Static method in interface com.github.punch.api.node.IReservedStreams

isValid(String, ConstraintValidatorContext) - Method in class com.github.punch.api.validations.HostValidator

N

NodeSettings - Interface in com.github.punch.api.node

Full node configuration

P

PREFIX - Static variable in interface com.github.punch.api.node.IReservedStreams

Define the prefix used in any IReservedStreams

print(int, boolean, boolean) - Method in class com.github.punch.api.printer.PunchPrinter

Print this printer to stdout (or stderr if errorOutput was set to true)

print(boolean) - Method in class com.github.punch.api.printer.PunchPrinter

Print this printer with 0 offset and sub printers

print() - Method in class com.github.punch.api.printer.PunchPrinter

Print this printer with 0 offset and colors and sub printers

print(int, boolean) - Method in class com.github.punch.api.printer.PunchPrinter

Print this printer and sub printers

print(int) - Method in class com.github.punch.api.printer.PunchPrinter

Print this printer with colors and sub printers

printException(int, Exception) - Static method in class com.github.punch.api.printer.PunchPrinter

Default printing for exception

publishMap(String, TypeReference<?>) - Method in interface com.github.punch.api.node.PunchNodePubSub

Deprecated.

publishMap(TypeReference<?>) - Method in interface com.github.punch.api.node.PunchNodePubSub

Publish a single untagged map value

publishSingleton(String, TypeReference<?>) - Method in interface com.github.punch.api.node.PunchNodePubSub

Publish a single tagged value

publishSingleton(TypeReference<?>) - Method in interface com.github.punch.api.node.PunchNodePubSub

Publish a single untagged map value

PunchBaseNode - Interface in com.github.punch.api.node

Top interface for all type of nodes.

PunchClassNotFoundException - Exception in com.github.punch.api.exceptions

This exception is used to report a PML configuration problem related to an unknown class type.

PunchClassNotFoundException(String) - Constructor for exception com.github.punch.api.exceptions.PunchClassNotFoundException

Report an unknwon punchline node

PunchlineException - Exception in com.github.punch.api.exceptions

This is the base class for all PML configuration/validation exceptions.

PunchlineException(Exception) - Constructor for exception com.github.punch.api.exceptions.PunchlineException

PunchlineException() - Constructor for exception com.github.punch.api.exceptions.PunchlineException

Ctor

PunchlineException(String) - Constructor for exception com.github.punch.api.exceptions.PunchlineException

PunchlineException(String, Throwable) - Constructor for exception com.github.punch.api.exceptions.PunchlineException

PunchNode - Annotation Type in com.github.punch.api.node

PunchNodeException - Exception in com.github.punch.api.exceptions

This exception is used to report a PML configuration problem related to a specific node from the PML graph.

PunchNodeException() - Constructor for exception com.github.punch.api.exceptions.PunchNodeException

PunchNodeException(Exception) - Constructor for exception com.github.punch.api.exceptions.PunchNodeException

PunchNodeException(String) - Constructor for exception com.github.punch.api.exceptions.PunchNodeException

PunchNodeException(String, Exception) - Constructor for exception com.github.punch.api.exceptions.PunchNodeException

PunchNodePubSub - Interface in com.github.punch.api.node

PunchNodeSettingException - Exception in com.github.punch.api.exceptions

Exception related to a specific setting in a PML node

PunchNodeSettingException(String, String) - Constructor for exception com.github.punch.api.exceptions.PunchNodeSettingException

PunchPrinter - Class in com.github.punch.api.printer

This class is a console printer helper:

PunchPrinter() - Constructor for class com.github.punch.api.printer.PunchPrinter

Constructor

PunchPrinter.Color - Enum in com.github.punch.api.printer

Ansi color code

PunchProperty - Annotation Type in com.github.punch.api.node

PunchProperty.Type - Enum in com.github.punch.api.node

PunchSubscriptionNotFoundException - Exception in com.github.punch.api.exceptions

This exception class relates to subscription errors in the PML graph (unknown component or stream in component)

PunchSubscriptionNotFoundException(String, String, String) - Constructor for exception com.github.punch.api.exceptions.PunchSubscriptionNotFoundException

PunchSubscriptionNotFoundException(String, String) - Constructor for exception com.github.punch.api.exceptions.PunchSubscriptionNotFoundException

put(Object) - Method in interface com.github.punch.api.node.StreamDeclaration

R

reservedStreams - Static variable in interface com.github.punch.api.node.IReservedStreams

List of all known reserved streams

S

setErrorOutput(boolean) - Method in class com.github.punch.api.printer.PunchPrinter

setLeftColor(PunchPrinter.Color) - Method in class com.github.punch.api.printer.PunchPrinter

Set left message color

setLeftMessage(String) - Method in class com.github.punch.api.printer.PunchPrinter

Set left message

setNodeName(String) - Method in exception com.github.punch.api.exceptions.PunchNodeException

setRightColor(PunchPrinter.Color) - Method in class com.github.punch.api.printer.PunchPrinter

Set right message color

setRightMessage(String) - Method in class com.github.punch.api.printer.PunchPrinter

Set right message

setSubMessage(String) - Method in class com.github.punch.api.printer.PunchPrinter

Set sub message

setSubMessageColor(PunchPrinter.Color) - Method in class com.github.punch.api.printer.PunchPrinter

Set sub message color

setSubscriptedStreamName(String) - Method in exception com.github.punch.api.exceptions.PunchSubscriptionNotFoundException

StreamDeclaration - Interface in com.github.punch.api.node

subscribeList(String, TypeReference<?>) - Method in interface com.github.punch.api.node.PunchNodePubSub

subscribe to a value list

subscribeList(TypeReference<?>) - Method in interface com.github.punch.api.node.PunchNodePubSub

subscribe to an untagged value list

subscribeMap(String, TypeReference<?>) - Method in interface com.github.punch.api.node.PunchNodePubSub

subscribe to a value map

subscribeMap(TypeReference<?>) - Method in interface com.github.punch.api.node.PunchNodePubSub

subscribe to an untagged value map

subscribeSingleton(String, TypeReference<?>) - Method in interface com.github.punch.api.node.PunchNodePubSub

Subscribe to a singleton input value.

subscribeSingleton(TypeReference<?>) - Method in interface com.github.punch.api.node.PunchNodePubSub

Subscribed to a singletong (untagged) value

T

toJson() - Method in exception com.github.punch.api.exceptions.PunchlineException

toJson() - Method in interface com.github.punch.api.node.NodeSettings

V

valueOf(String) - Static method in enum com.github.punch.api.node.PunchProperty.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.punch.api.printer.PunchPrinter.Color

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.punch.api.node.PunchProperty.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.punch.api.printer.PunchPrinter.Color

Returns an array containing the constants of this enum type, in the order they are declared.

_

_PPF_EOB - Static variable in interface com.github.punch.api.node.IReservedStreams

Punch exceptions are catched and emitted on this error stream

_PPF_ERRORS - Static variable in interface com.github.punch.api.node.IReservedStreams

Punch exceptions are catched and emitted on this error stream

_PPF_METRICS - Static variable in interface com.github.punch.api.node.IReservedStreams

Latency points are emitted on a reserved stream.

_PPF_SUCCESSES - Static variable in interface com.github.punch.api.node.IReservedStreams

A C G H I N P R S T V _