net.sf.eBusx.monitor.Monitorable Maven / Gradle / Ivy
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later
// version.
//
// This library is distributed in the hope that it will be
// useful, but WITHOUT ANY WARRANTY; without even the implied
// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
// PURPOSE. See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General
// Public License along with this library; if not, write to the
//
// Free Software Foundation, Inc.,
// 59 Temple Place, Suite 330,
// Boston, MA
// 02111-1307 USA
//
// The Initial Developer of the Original Code is Charles W. Rapp.
// Portions created by Charles W. Rapp are
// Copyright 2011. Charles W. Rapp
// All Rights Reserved.
//
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