org.xwiki.model.validation

Class AbstractEntityNameValidation

java.lang.Object

org.xwiki.model.validation.AbstractEntityNameValidation

All Implemented Interfaces:

EntityNameValidation

@Unstable
public abstract class AbstractEntityNameValidation
extends Object
implements EntityNameValidation

Define generic methods for transforming or validating entities based on the implementation of the EntityNameValidation.transform(String) and EntityNameValidation.isValid(String).

Since:

12.0RC1

Version:

$Id: 8ff8cc6e5893220adcbab791d9a45563a4094da0 $

Constructor Summary

Constructors

Constructor and Description
AbstractEntityNameValidation()

Method Summary

Modifier and Type	Method and Description
boolean	isValid(EntityReference entityReference) Validate that the given EntityReference respects the current policy.
EntityReference	transform(EntityReference entityReference) Aims at transforming an entity reference such as EntityNameValidation.isValid(EntityReference) returns true.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.model.validation.EntityNameValidation

isValid, transform

Constructor Detail

AbstractEntityNameValidation

public AbstractEntityNameValidation()

Method Detail

transform

public EntityReference transform(EntityReference entityReference)

Description copied from interface: EntityNameValidation

Aims at transforming an entity reference such as EntityNameValidation.isValid(EntityReference) returns true. Note that this method should return exactly entityReference if EntityNameValidation.isValid(EntityReference) already returns true for it.

Specified by:

transform in interface EntityNameValidation

Parameters:

entityReference - the entity reference on which to perform transformation.

Returns:

a new EntityReference with the fewer possible transformation to make it pass EntityNameValidation.isValid(EntityReference).

isValid

public boolean isValid(EntityReference entityReference)

Description copied from interface: EntityNameValidation

Validate that the given EntityReference respects the current policy.

Specified by:

isValid in interface EntityNameValidation

Parameters:

entityReference - the entity reference to check

Returns:

true if the policy is respected.