net.sf.eBusx.monitor.Monitorable Maven / Gradle / Ivy

Go to download
//
// Copyright 2011 Charles W. Rapp
//
// 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 net.sf.eBusx.monitor;

/**
 * Objects to be registered with {@link Monitor} must implement
 * this interface. {@link Monitor} uses this interface to
 * retrieve the monitored object's instance name.
 *
 * @author Charles Rapp
 */

public interface Monitorable
{
    //---------------------------------------------------------------
    // Member methods.
    //

    /**
     * Returns the monitored object's name. The instance name may
     * not be {@code null} or an empty string. It should be
     * unique within the JVM and the object's class.
     * @return the monitored object's name.
     */
    public String instanceName();
} // end of interface Monitorable