org.jacpfx.api.component.Component Maven / Gradle / Ivy
/************************************************************************
*
* Copyright (C) 2010 - 2014
*
* [Component.java]
* JACPFX Project (https://github.com/JacpFX/JacpFX/)
* 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.jacpfx.api.component;
import org.jacpfx.api.context.JacpContext;
/**
* This Interface represents a very basic component that can exists in JACP
* environment.
*
* @param defines the message listener type
* @param defines the basic message type
* @author Andy Moncsek
*/
public interface Component extends Comparable> {
/**
* Get if component was activated, can occur if message was send before
* "init" message arrived.
*
* @return the active status
*/
boolean isStarted();
/**
* Set once when component was first started
*
* @param started, set to true if the component was initialized correctly.
*/
void setStarted(final boolean started);
/**
* Represents the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.
*
* @return the locale id
*/
String getLocaleID();
/**
* Set the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.
*
* @param localeId, The locale id.
*/
void setLocaleID(final String localeId);
/**
* Represents the location of your resource bundle file.
*
* @return the url of resource bundle
*/
String getResourceBundleLocation();
/**
* Set the location of your resource bundle file.
*
* @param location . The location of the resource bundle.
*/
void setResourceBundleLocation(final String location);
/**
* Returns the component context object.
*
* @return the context object.
*/
JacpContext getContext();
}