jdk/src/share/classes/java/lang/Runnable.java
author martin
Mon, 10 Mar 2008 14:32:51 -0700
changeset 48 dc5744ca15ea
parent 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
4960438: (process) Need IO redirection API for subprocesses Reviewed-by: alanb, iris
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1994-2005 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.lang;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * The <code>Runnable</code> interface should be implemented by any
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * class whose instances are intended to be executed by a thread. The
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * class must define a method of no arguments called <code>run</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * This interface is designed to provide a common protocol for objects that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * wish to execute code while they are active. For example,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * <code>Runnable</code> is implemented by class <code>Thread</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * Being active simply means that a thread has been started and has not
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * yet been stopped.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * In addition, <code>Runnable</code> provides the means for a class to be
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * active while not subclassing <code>Thread</code>. A class that implements
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * <code>Runnable</code> can run without subclassing <code>Thread</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * by instantiating a <code>Thread</code> instance and passing itself in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * as the target.  In most cases, the <code>Runnable</code> interface should
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * be used if you are only planning to override the <code>run()</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * method and no other <code>Thread</code> methods.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * This is important because classes should not be subclassed
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * unless the programmer intends on modifying or enhancing the fundamental
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * behavior of the class.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * @author  Arthur van Hoff
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * @see     java.lang.Thread
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * @see     java.util.concurrent.Callable
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 * @since   JDK1.0
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
public
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
interface Runnable {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * When an object implementing interface <code>Runnable</code> is used
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * to create a thread, starting the thread causes the object's
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * <code>run</code> method to be called in that separately executing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     * thread.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * The general contract of the method <code>run</code> is that it may
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * take any action whatsoever.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * @see     java.lang.Thread#run()
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    public abstract void run();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
}