Package com.inductiveautomation.ignition.common.util

Class NameUtil

java.lang.Object

com.inductiveautomation.ignition.common.util.NameUtil

public class NameUtil
extends java.lang.Object

This class provides helper functions for naming objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NameUtil.BasicNameFactory	The basic name factory generates sequential names with simple pattern detection.
static interface	NameUtil.NameFactory
static interface	NameUtil.NameProvider<T>	For a given object, provides its name.
static interface	NameUtil.NameValidator	The implementor will return whether the provided name exists or not.
static class	NameUtil.TrackingNameValidatorWrapper	This NameValidator wrapper is used for generating many names, when the underlying name validator won't be updated on the fly.

Constructor Summary

Constructors

Constructor	Description
NameUtil()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	nextName(NameUtil.NameFactory factory, NameUtil.NameValidator validator)
static java.lang.String	nextName(java.lang.String baseName, NameUtil.NameValidator validator)	Returns the next name generated off of the given base name.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameUtil

public NameUtil()

Method Detail

nextName

public static java.lang.String nextName(java.lang.String baseName,
                                        NameUtil.NameValidator validator)

Returns the next name generated off of the given base name. Uses simple pattern detection for "name 0" or "name (0)".

nextName

public static java.lang.String nextName(NameUtil.NameFactory factory,
                                        NameUtil.NameValidator validator)