X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=system%2Fgeneral%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fsystem%2Fcore%2FComponent.java;h=e70baa23d2f9b0a5b5da13bc1adeaed30bb35211;hb=ddd261f331280640c5b53c7128230b629ebcd268;hp=9506bb1f32c3fc874b9460cad4ac6e0757c0e6b3;hpb=92e23e5ecf9614f2ab770a8cdedc0b21ddf1e127;p=utils diff --git a/system/general/src/main/java/org/wamblee/system/core/Component.java b/system/general/src/main/java/org/wamblee/system/core/Component.java index 9506bb1f..e70baa23 100644 --- a/system/general/src/main/java/org/wamblee/system/core/Component.java +++ b/system/general/src/main/java/org/wamblee/system/core/Component.java @@ -1,22 +1,23 @@ /* * Copyright 2007 the original author or authors. - * + * * 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.wamblee.system.core; import java.util.List; + /** * A component represents a part of a system that requires a * number of interfaces and provides a number of interfaces. @@ -32,57 +33,84 @@ import java.util.List; * @author Erik Brakkee */ public interface Component { - - /** - * Gets the name of the subsystem. - * @return Subsystem name. - */ - String getName(); - - /** - * Prepends the context with a super context. - */ - void addContext(String aContext); - - /** - * Getst the context. - * @return Context or null if not set. - */ - String getContext(); - - /** - * Gets the fully qualified name of the component which includes - * the context of the component. - * This method can only be used after the component has started. - * @return Qualified name. - */ - String getQualifiedName(); + /** + * Gets the name of the subsystem. + * + * @return Subsystem name. + */ + String getName(); + + /** + * Prepends the context with a super context. + * + * @param aContext DOCUMENT ME! + */ + void addContext(String aContext); + + /** + * Getst the context. + * + * @return Context or null if not set. + */ + String getContext(); + + /** + * Gets the fully qualified name of the component which includes + * the context of the component. This method can only be used after the + * component has started. + * + * @return Qualified name. + */ + String getQualifiedName(); + + /** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ +/** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ +/** + * Gets a description of the provided interfaces. + * @return Provided interfaces. + */ + List getProvidedInterfaces(); + + /** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ +/** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ +/** + * Gets a description of the required interfaces. + * @return Required interfaces. + */ + List getRequiredInterfaces(); - /** - * Gets a description of the provided interfaces. - * @return Provided interfaces. - */ - List getProvidedInterfaces(); - - /** - * Gets a description of the required interfaces. - * @return Required interfaces. - */ - List getRequiredInterfaces(); + /** + * Initialises the subsystem by starting all the services that it + * described as provided. + * + * @param aScope Scope with external interface implementations that are + * available. The component must publish its runtime and its + * provided interfaces in this scope. + * + * @return Gets an object representing the runtime of the component. + */ + Type start(Scope aScope); - - /** - * Initialises the subsystem by starting all the services that - * it described as provided. - * @param aScope Scope with external interface implementations that are available. The component - * must publish its runtime and its provided interfaces in this scope. - * @return Gets an object representing the runtime of the component. - */ - Type start(Scope aScope); - - /** - * Stops a component. - * @param aRuntime THe runtime part of the component. - */ - void stop(Type aRuntime); + /** + * Stops a component. + * + * @param aRuntime THe runtime part of the component. + */ + void stop(Type aRuntime); }