com.sun.hk2.component.ExistingSingletonInhabitant Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of auto-depends Show documentation
${project.name}
There is a newer version: 1.6.9
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2007-2011 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package com.sun.hk2.component;

import org.jvnet.hk2.component.ComponentException;
import org.jvnet.hk2.component.Inhabitant;
import org.jvnet.hk2.component.MultiMap;

/**
 * {@link Inhabitant} built around an object that already exists.
 *
 * @author Kohsuke Kawaguchi
 */
public class ExistingSingletonInhabitant extends AbstractInhabitantImpl {
    private final T object;
    private final Class type;
    private final MultiMap metadata;

    public ExistingSingletonInhabitant(T object) {
        this((Class)object.getClass(),object);
    }

    public ExistingSingletonInhabitant(Class type, T object) {
        this(type,object,MultiMap.emptyMap());
    }

    public ExistingSingletonInhabitant(Class type, T object, MultiMap metadata) {
        this.type = type;
        this.object = object;
        this.metadata = (null == metadata) ? new MultiMap() : metadata;
    }
    
    @Override
    public String toString() {
        return getClass().getSimpleName() + "-" + System.identityHashCode(this) + 
          "(" + get(null) + "," + metadata + ")";
    }

    @Override
    public String typeName() {
        return type.getName();
    }

    @Override
    public Class type() {
        return type;
    }

    @Override
    public MultiMap metadata() {
        return metadata;
    }

    public T get(Inhabitant onBehalfOf) throws ComponentException {
        return object;
    }

    @Override
    public boolean isInstantiated() {
        return true;
    }

    @Override
    public void release() {
        // since we are working on the existing object,
        // we can't release its instance.
        // (technically it's possible to invoke PreDestroy,
        // not clear which is better --- you can argue both ways.)
    }
}