src/java/com/google/ipc/invalidation/util/NamedRunnable.java

/*
 * Copyright 2011 Google Inc.
 *
 * 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 com.google.ipc.invalidation.util;

/**
 * A wrapper around the {@link Runnable} interface that provides extra information (e.g., a name)
 * for logging, monitoring, debugging, etc.
 *
 */
public abstract class NamedRunnable implements Runnable {

  /** The name of this runnable. */
  private final String name;

  /** Constructs a named runnable with the given name. */
  public NamedRunnable(String name) {
    Preconditions.checkNotNull(name, "name is null");
    this.name = name;
  }

  @Override
  public String toString() {
    return name + ':' + super.toString();
  }

  public String getName() {
    return name;
  }
}