Package com.evolveum.midpoint.schema.config

Class FunctionConfigItem

java.lang.Object

com.evolveum.midpoint.schema.config.ConfigurationItem<ExpressionType>

com.evolveum.midpoint.schema.config.ExpressionConfigItem

com.evolveum.midpoint.schema.config.FunctionConfigItem

All Implemented Interfaces:

PrivilegesMixin<ExpressionType>, Serializable, Cloneable

public class FunctionConfigItem
extends ExpressionConfigItem

Represents an ExpressionType that is part of a FunctionLibraryType as a custom function. Intentionally differs from the standard naming convention. The embedded value is ExpressionType but it is used in a specialized way.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.evolveum.midpoint.schema.config.ConfigurationItem

DESC

Constructor Summary

Constructors

Constructor	Description
FunctionConfigItem(@NotNull ConfigurationItem<ExpressionType> original)

Method Summary

Modifier and Type	Method	Description
<X extends ConfigurationItem<T>> X	as(@NotNull Class<X> clazz)
default void	checkNamespace(@NotNull QName name, String expectedNamespace)
<X extends Serializable & Cloneable, CI extends ConfigurationItem<X>> CI	child(X value, @NotNull Class<CI> clazz, Object... pathSegments)
default void	configCheck(boolean value, String template, Object... arguments)	Checks the value, and if it's `false`, emits a ConfigurationException.
default @NotNull ConfigurationException	configException(String template, Object... arguments)
default @NotNull ConfigurationException	configException(Throwable cause, String template, Object... arguments)
default <V> V	configNonNull(V value, String template, Object... arguments)	As configCheck(boolean, String, Object...), but checks that the value is not null.
boolean	doesMatchArguments(Collection<String> argumentNames)	Matching parameter names, ignoring all the other information (e.g., types).
default @NotNull QName	enforceNamespace(@NotNull QName name, @NotNull String requiredNamespace)	Just like QNameUtil.enforceNamespace(QName, String) but throwing ConfigurationException.
@NotNull String	fullDescription()
default @NotNull String	getLocalPart(@NotNull QName name, String expectedNamespace)
@NotNull String	getName()	Unlike general ExpressionConfigItem, the function must have a name.
@NotNull ExpressionParameterConfigItem	getParameter(@NotNull String paramName)
@NotNull QName	getReturnTypeName()
boolean	isReturnMultiValue()
boolean	isReturnSingleValue()
default <C extends Collection<?>> C	nonEmpty(C collection, Object itemDescription)
default <C extends Collection<?>> C	nonEmpty(C collection, String template, Object... arguments)
default <V> V	nonNull(V value, Object itemDesc)	Even more shortened version.
static FunctionConfigItem	of(@NotNull ExpressionType bean, @NotNull ConfigurationItemOrigin origin)
@NotNull ConfigurationItemOrigin	origin()	See ConfigurationItem.origin.
default @NotNull ConfigurationItemOrigin	originFor(@NotNull ItemPath path)
default <C extends Containerable> @NotNull OriginProvider<C>	originProviderFor(@NotNull ItemPath path)
default <C> C	single(Collection<? extends C> collection, String template, Object... arguments)
default @NotNull ItemName	singleNameRequired(ItemPathType name, Object itemDesc)
ExpressionType	value()	See ConfigurationItem.value.

Methods inherited from class com.evolveum.midpoint.schema.config.ExpressionConfigItem

getPrivileges, isAllowEmptyValues, isTrace

Methods inherited from class com.evolveum.midpoint.schema.config.ConfigurationItem

as, as, asList, child, child, clone, configItem, configItem, configItemNullable, embedded, embeddedNullable, equals, fullDescription, fullOriginLessDescription, hashCode, localDescription, of, ofList, origin, toString, value, value

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.schema.config.PrivilegesMixin

getPrivileges

Constructor Details

FunctionConfigItem

public FunctionConfigItem(@NotNull
 @NotNull ConfigurationItem<ExpressionType> original)

Method Details

of

public static FunctionConfigItem of(@NotNull
 @NotNull ExpressionType bean,
 @NotNull
 @NotNull ConfigurationItemOrigin origin)

getName

@NotNull
public @NotNull String getName()
                        throws ConfigurationException

Unlike general ExpressionConfigItem, the function must have a name.

Throws:

ConfigurationException

doesMatchArguments

public boolean doesMatchArguments(Collection<String> argumentNames)

Matching parameter names, ignoring all the other information (e.g., types).

getParameter

@NotNull
public @NotNull ExpressionParameterConfigItem getParameter(@NotNull
 @NotNull String paramName)
                                                    throws ConfigurationException

Throws:

ConfigurationException

getReturnTypeName

@NotNull
public @NotNull QName getReturnTypeName()

isReturnMultiValue

public boolean isReturnMultiValue()

isReturnSingleValue

public boolean isReturnSingleValue()

value

@NotNull
ExpressionType value()

See ConfigurationItem.value.

origin

@NotNull
@NotNull ConfigurationItemOrigin origin()

See ConfigurationItem.origin.

as

@NotNull
<X extends ConfigurationItem<T>> X as(@NotNull
 @NotNull Class<X> clazz)

child

@Contract("null, _, _ -> null; !null, _, _ -> !null")
<X extends Serializable & Cloneable,
CI extends ConfigurationItem<X>>
CI child(@Nullable
 X value,
 @NotNull
 @NotNull Class<CI> clazz,
 Object... pathSegments)

fullDescription

@NotNull
@NotNull String fullDescription()

configCheck

@Contract("false, _, _ -> fail")
default void configCheck(boolean value,
 String template,
 Object... arguments)
                  throws ConfigurationException

Checks the value, and if it's `false`, emits a ConfigurationException. Note that ConfigurationItem.DESC can be used as a placeholder for fullDescription() in the `arguments`.

Throws:

ConfigurationException

checkNamespace

default void checkNamespace(@NotNull
 @NotNull QName name,
 String expectedNamespace)
                     throws ConfigurationException

Throws:

ConfigurationException

enforceNamespace

@NotNull
default @NotNull QName enforceNamespace(@NotNull
 @NotNull QName name,
 @NotNull
 @NotNull String requiredNamespace)
                                 throws ConfigurationException

Just like QNameUtil.enforceNamespace(QName, String) but throwing ConfigurationException.

Throws:

ConfigurationException

getLocalPart

@NotNull
default @NotNull String getLocalPart(@NotNull
 @NotNull QName name,
 String expectedNamespace)
                              throws ConfigurationException

Throws:

ConfigurationException

configException

@NotNull
default @NotNull ConfigurationException configException(Throwable cause,
 String template,
 Object... arguments)

configException

@NotNull
default @NotNull ConfigurationException configException(String template,
 Object... arguments)

configNonNull

@Contract("null, _, _ -> fail")
@NotNull
default <V> V configNonNull(V value,
 String template,
 Object... arguments)
                     throws ConfigurationException

As configCheck(boolean, String, Object...), but checks that the value is not null.

Throws:

ConfigurationException

nonNull

@Contract("null, _ -> fail")
@NotNull
default <V> V nonNull(V value,
 Object itemDesc)
               throws ConfigurationException

Even more shortened version.

Throws:

ConfigurationException

nonEmpty

@NotNull
default <C extends Collection<?>> C nonEmpty(C collection,
 Object itemDescription)
                                      throws ConfigurationException

Throws:

ConfigurationException

nonEmpty

@NotNull
default <C extends Collection<?>> C nonEmpty(C collection,
 String template,
 Object... arguments)
                                      throws ConfigurationException

Throws:

ConfigurationException

singleNameRequired

@NotNull
default @NotNull ItemName singleNameRequired(ItemPathType name,
 Object itemDesc)
                                      throws ConfigurationException

Throws:

ConfigurationException

single

@Nullable
default <C> C single(Collection<? extends C> collection,
 String template,
 Object... arguments)
              throws ConfigurationException

Throws:

ConfigurationException

originProviderFor

@NotNull
default <C extends Containerable>
@NotNull OriginProvider<C> originProviderFor(@NotNull
 @NotNull ItemPath path)

originFor

@NotNull
default @NotNull ConfigurationItemOrigin originFor(@NotNull
 @NotNull ItemPath path)