com.helger.schematron.pure.bound.PSBoundSchemaCache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-schematron Show documentation

Library for validating XML documents with Schematron

There is a newer version: 5.6.5

/**
 * Copyright (C) 2014-2017 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.schematron.pure.bound;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ELockType;
import com.helger.commons.annotation.IsLocked;
import com.helger.commons.cache.AbstractNotifyingCache;
import com.helger.schematron.SchematronException;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

/**
 * A cache for {@link IPSBoundSchema} instances. Use {@link #getInstance()} to
 * retrieve a global singleton instance. Alternatively you may instantiate this
 * class regularly.
 *
 * @author Philip Helger
 */
public class PSBoundSchemaCache extends AbstractNotifyingCache 
{
  private static final class SingletonHolder
  {
    static final PSBoundSchemaCache s_aInstance = new PSBoundSchemaCache ();
  }

  /**
   * Default constructor for the singleton.
   */
  private PSBoundSchemaCache ()
  {
    super (PSBoundSchemaCache.class.getName ());
  }

  public PSBoundSchemaCache (@Nonnull final String sCacheName)
  {
    super (sCacheName);
  }

  @Nonnull
  public static PSBoundSchemaCache getInstance ()
  {
    return SingletonHolder.s_aInstance;
  }

  @Override
  @Nonnull
  @IsLocked (ELockType.WRITE)
  @SuppressFBWarnings ("NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE")
  protected IPSBoundSchema getValueToCache (@Nullable final PSBoundSchemaCacheKey aKey)
  {
    ValueEnforcer.notNull (aKey, "Key");

    try
    {
      return aKey.createBoundSchema ();
    }
    catch (final SchematronException ex)
    {
      // Convert to an unchecked exception :(
      throw new IllegalArgumentException (ex);
    }
  }
}