com.helger.bdve.executorset.ValidationExecutorSet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-bdve Show documentation
Show all versions of ph-bdve Show documentation
Business Document Validation Engine (BDVE) API
/**
* Copyright (C) 2014-2018 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.bdve.executorset;
import java.util.Iterator;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.concurrent.NotThreadSafe;
import com.helger.bdve.execute.IValidationExecutor;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.CommonsArrayList;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.state.EChange;
import com.helger.commons.string.ToStringGenerator;
/**
* Default implementation of {@link IValidationExecutorSet}.
*
* @author Philip Helger
*/
@NotThreadSafe
public class ValidationExecutorSet implements IValidationExecutorSet
{
private final VESID m_aID;
private final String m_sDisplayName;
private final ICommonsList m_aList = new CommonsArrayList <> ();
private final boolean m_bDeprecated;
public ValidationExecutorSet (@Nonnull final VESID aID,
@Nonnull @Nonempty final String sDisplayName,
final boolean bDeprecated)
{
m_aID = ValueEnforcer.notNull (aID, "ID");
m_sDisplayName = ValueEnforcer.notEmpty (sDisplayName, "DisplayName");
m_bDeprecated = bDeprecated;
}
@Nonnull
public VESID getID ()
{
return m_aID;
}
@Nonnull
@Nonempty
public String getDisplayName ()
{
return m_sDisplayName;
}
@Nonnegative
public int getExecutorCount ()
{
return m_aList.size ();
}
@Nonnull
public Iterator iterator ()
{
return m_aList.iterator ();
}
@Nonnull
@ReturnsMutableCopy
public ICommonsList getAllExecutors ()
{
return m_aList.getClone ();
}
public boolean isDeprecated ()
{
return m_bDeprecated;
}
/**
* Add a single executor.
*
* @param aExecutor
* The executor to be added. May not be null.
* @return this for chaining
*/
@Nonnull
public ValidationExecutorSet addExecutor (@Nonnull final IValidationExecutor aExecutor)
{
ValueEnforcer.notNull (aExecutor, "Executor");
m_aList.add (aExecutor);
return this;
}
public void setValidationExecutorDoCache (final boolean bCache)
{
for (final IValidationExecutor aExecutor : m_aList)
if (aExecutor instanceof IValidationExecutor.ICacheSupport)
((IValidationExecutor.ICacheSupport) aExecutor).setCacheArtefact (bCache);
}
/**
* As some {@link IValidationExecutor} instances may contain a hard reference
* to a {@link ClassLoader} this methods removes all executors and allows for
* them to be garbage collected.
* New executors may be added afterwards but this method is mainly meant for
* safe cleanup.
*
* @return {@link EChange}
*/
@Nonnull
public EChange removeAllExecutors ()
{
return m_aList.removeAll ();
}
@Override
public boolean equals (final Object o)
{
if (o == this)
return true;
if (o == null || !getClass ().equals (o.getClass ()))
return false;
final ValidationExecutorSet rhs = (ValidationExecutorSet) o;
return m_aID.equals (rhs.m_aID) && m_sDisplayName.equals (rhs.m_sDisplayName) && m_aList.equals (rhs.m_aList);
}
@Override
public int hashCode ()
{
return new HashCodeGenerator (this).append (m_aID).append (m_sDisplayName).append (m_aList).getHashCode ();
}
@Override
public String toString ()
{
return ToStringGenerator.getDerived (super.toString ())
.append ("ID", m_aID)
.append ("DisplayName", m_sDisplayName)
.append ("List", m_aList)
.getToString ();
}
@Nonnull
public static ValidationExecutorSet create (@Nonnull final VESID aID,
@Nonnull @Nonempty final String sDisplayName,
final boolean bIsDeprecated,
@Nonnull final IValidationExecutor... aValidationExecutors)
{
ValueEnforcer.notNull (aID, "ID");
ValueEnforcer.notEmpty (sDisplayName, "DisplayName");
ValueEnforcer.noNullValue (aValidationExecutors, "ValidationExecutors");
final ValidationExecutorSet ret = new ValidationExecutorSet (aID, sDisplayName, bIsDeprecated);
// Add Schematrons
for (final IValidationExecutor aItem : aValidationExecutors)
ret.addExecutor (aItem);
return ret;
}
/**
* Create a derived VES from an existing VES. This means that only Schematrons
* can be added, but the XSDs are taken from the base VES only.
*
* @param aBaseVES
* The base VES to copy from. May not be null.
* @param aID
* The ID to use. May not be null.
* @param sDisplayName
* The name of the VES. May neither be null nor empty.
* @param bIsDeprecated
* true if this VES is considered deprecated,
* false if not.
* @param aValidationExecutors
* The resources to be associated with the VES. May not be
* null.
* @return The newly created VES. Never null.
*/
@Nonnull
public static ValidationExecutorSet createDerived (@Nonnull final IValidationExecutorSet aBaseVES,
@Nonnull final VESID aID,
@Nonnull @Nonempty final String sDisplayName,
final boolean bIsDeprecated,
@Nonnull final IValidationExecutor... aValidationExecutors)
{
ValueEnforcer.notNull (aBaseVES, "BaseVES");
ValueEnforcer.notNull (aID, "ID");
ValueEnforcer.notEmpty (sDisplayName, "DisplayName");
ValueEnforcer.notEmptyNoNullValue (aValidationExecutors, "ValidationExecutors");
final ValidationExecutorSet ret = new ValidationExecutorSet (aID,
sDisplayName,
bIsDeprecated || aBaseVES.isDeprecated ());
// Copy all existing ones
for (final IValidationExecutor aVE : aBaseVES)
ret.addExecutor (aVE);
// Add Schematrons
for (final IValidationExecutor aVE : aValidationExecutors)
ret.addExecutor (aVE);
return ret;
}
}