org.xwiki.script.wrap.AbstractWrappingObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-script Show documentation

Scripting APIs, on top of JSR-223

There is a newer version: 16.10.0-rc-1

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.script.wrap;

/**
 * Wrap an Object.
 *
 * @param  the type of the wrapped object
 * @version $Id: 2e4257344ff5db58fc842bf7ef7cce7473bcf68c $
 * @since 4.0M1
 */
public abstract class AbstractWrappingObject
{
    /**
     * @see #getWrapped()
     */
    private T wrapped;

    /**
     * @param wrapped the wrapped object
     */
    public AbstractWrappingObject(T wrapped)
    {
        this.wrapped = wrapped;
    }

    /**
     * A default constructor allowing to set the wrapped object later.
     * 
     * @since 12.9RC1
     */
    protected AbstractWrappingObject()
    {

    }

    /**
     * @return the wrapped object
     * @since 12.9RC1
     */
    protected T getWrapped()
    {
        if (this.wrapped == null) {
            this.wrapped = resolveWrapped();
        }

        return this.wrapped;
    }

    /**
     * @return the wrapped object
     * @since 12.9RC1
     */
    protected T resolveWrapped()
    {
        throw new UnsupportedOperationException();
    }

    // Object

    @Override
    public int hashCode()
    {
        return getWrapped().hashCode();
    }

    @Override
    public boolean equals(Object obj)
    {
        return getWrapped().equals(obj);
    }

    @Override
    public String toString()
    {
        return getWrapped().toString();
    }
}