com.phloc.scopes.ScopeRenewalAwareWrapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-scopes Show documentation

Library for handling scopes in a generic way

There is a newer version: 6.4.4

/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[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.phloc.scopes;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;

import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.mutable.IReadonlyWrapper;
import com.phloc.commons.mutable.Wrapper;

/**
 * This is a wrapper around any object that is scope renewal aware.
 * 
 * @author Philip Helger
 * @param 
 *        The type of object to be wrapped. Must implement {@link Serializable}.
 */
@NotThreadSafe
public class ScopeRenewalAwareWrapper  extends Wrapper  implements IScopeRenewalAware, Serializable
{
  /**
   * Default constructor.
   */
  public ScopeRenewalAwareWrapper ()
  {}

  /**
   * Constructor with an existing object.
   * 
   * @param aObj
   *        The existing object. May be null.
   */
  public ScopeRenewalAwareWrapper (@Nullable final DATATYPE aObj)
  {
    super (aObj);
  }

  /**
   * Copy constructor. Only takes wrappers of the same type.
   * 
   * @param rhs
   *        The other wrapper to use. May not be null.
   */
  public ScopeRenewalAwareWrapper (@Nonnull final IReadonlyWrapper  rhs)
  {
    super (rhs);
  }

  @Override
  @Nonnull
  @ReturnsMutableCopy
  public ScopeRenewalAwareWrapper  getClone ()
  {
    return new ScopeRenewalAwareWrapper  (get ());
  }

  /**
   * Static factory method with automatic type deduction.
   * 
   * @param 
   *        The type to be wrapped.
   * @param aObj
   *        The object to be wrapped.
   * @return The wrapped object.
   */
  @Nonnull
  public static  ScopeRenewalAwareWrapper  create (@Nullable final DATATYPE aObj)
  {
    return new ScopeRenewalAwareWrapper  (aObj);
  }
}