org.osgi.framework.wiring.dto.BundleWiringDTO Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation

AspectJ tools most notably contains the AspectJ compiler (AJC). AJC applies aspects to Java classes during compilation, fully replacing Javac for plain Java classes and also compiling native AspectJ or annotation-based @AspectJ syntax. Furthermore, AJC can weave aspects into existing class files in a post-compile binary weaving step. This library is a superset of AspectJ weaver and hence also of AspectJ runtime.

There is a newer version: 1.9.22.1

Show newest version

/*
 * Copyright (c) OSGi Alliance (2012, 2014). All Rights Reserved.
 * 
 * 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 org.osgi.framework.wiring.dto;

import java.util.Set;
import org.osgi.dto.DTO;
import org.osgi.framework.wiring.BundleWiring;
import org.osgi.resource.dto.WiringDTO;

/**
 * Data Transfer Object for a BundleWiring graph.
 * 
 * 
 * An installed Bundle can be adapted to provide a {@code BundleWiringDTO} for
 * the current wiring Bundle. {@code BundleWiringDTO} objects for all in use
 * wirings of the Bundle can be obtained by adapting the bundle to
 * {@code BundleWiringDTO[]}.
 * 
 * @author $Id: e23e80fcf8a14cbc9f565ec146821a4f22f2731b $
 * @NotThreadSafe
 */
public class BundleWiringDTO extends DTO {
    /**
	 * The id of the bundle associated with the bundle wiring graph.
	 * 
	 * @see BundleWiring#getBundle()
	 */
    public long                   bundle;

    /**
     * The identifier of the root wiring node of the bundle wiring graph.
     * 
     * @see WiringDTO#id
     */
    public int                    root;

    /**
     * The set of wiring nodes referenced by the wiring graph.
     * 
     * 

     * All wiring nodes referenced by wiring node identifiers in the wiring
     * graph are contained in this set.
     */
    public Set           nodes;

    /**
     * The set of resources referenced by the wiring graph.
     * 
     * 

     * All resources referenced by resource identifiers in the wiring graph are
     * contained in this set.
     */
    public Set resources;

    /**
     * Data Transfer Object for a BundleWiring node.
     * 
     * 
     * The {@link WiringDTO#providedWires providedWires} field must contain an
     * array of {@link BundleWireDTO}s. The {@link WiringDTO#requiredWires
     * requiredWires} field must contain an array of {@link BundleWireDTO}s.
     * 
     * @NotThreadSafe
     */
    public static class NodeDTO extends WiringDTO {
        /**
		 * The bundle wiring's in use setting indicates that the bundle wiring
		 * is in use.
		 * 
		 * @see BundleWiring#isInUse()
		 */
        public boolean inUse;

        /**
		 * The current state of the bundle wiring. The bundle wiring's current
		 * setting indicates that the bundle wiring is the current bundle wiring
		 * for the bundle.
		 * 
		 * @see BundleWiring#isCurrent()
		 */
        public boolean current;
    }
}