stanford.karel

Class Karel

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Panel

java.applet.Applet

javax.swing.JApplet

acm.program.Program

stanford.karel.Karel

All Implemented Interfaces:

acm.io.IOModel, ProgramInterface, ActionListener, AdjustmentListener, ComponentListener, ContainerListener, FocusListener, ItemListener, KeyListener, MouseListener, MouseMotionListener, MouseWheelListener, TextListener, WindowFocusListener, WindowListener, WindowStateListener, ImageObserver, MenuContainer, Serializable, Runnable, EventListener, Accessible, ChangeListener, DocumentListener, ListDataListener, ListSelectionListener, MouseInputListener, PopupMenuListener, RootPaneContainer, KarelInterface

Direct Known Subclasses:

SuperKarel

public class Karel
extends Program
implements KarelInterface, Runnable

The Karel class represents the simplest possible Karel the Robot object. Each instance of the Karel class represents an individual robot that can move inside a world laid out as a grid of streets and avenues. The other characteristics of Karel's world include walls, which separate individual corners, and beepers, which are described by Karel's creator as "plastic cones which emit a quiet beeping noise." As it is shipped from the factory, Karel can execute only four operations:

move()

Moves this Karel forward one block. Karel cannot move forward if there is a wall blocking the way.

turnLeft()

Rotates this Karel 90 degrees to the left (counterclockwise).

pickBeeper()

Picks up one beeper from the current corner and stores the beeper in this Karel's beeper bag, which can hold an infinite number of beepers. Karel can execute a pickBeeper instruction only if there is a beeper on the current corner.

putBeeper()

Takes one beeper from this Karel's beeper bag and deposits it on the current corner. Karel can execute a pickBeeper instruction only if there is a beeper in its bag.

Karel programs are executed by defining a new subclass that extends Karel and provides it with a run method that defines its operation. For example, the following Karel subclass represents a Karel program that moves forward, picks up a beeper from the square, and then moves forward one more time:

public class SimpleKarelExample extends Karel { public void run() { move(); putBeeper(); move(); } }

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JApplet

JApplet.AccessibleJApplet

Nested classes/interfaces inherited from class java.applet.Applet

Applet.AccessibleApplet

Nested classes/interfaces inherited from class java.awt.Panel

Panel.AccessibleAWTPanel

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class acm.program.Program

CONFIG_FILE_NAME, invisibleObjects

Fields inherited from class javax.swing.JApplet

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface acm.program.ProgramInterface

CENTER

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
Karel()

Method Summary

Modifier and Type	Method and Description
boolean	beepersInBag()
boolean	beepersPresent()
protected void	checkWorld(String caller)
boolean	facingEast()
boolean	facingNorth()
boolean	facingSouth()
boolean	facingWest()
boolean	frontIsBlocked()
boolean	frontIsClear()
int	getBeepersInBag()
int	getDirection()
Point	getLocation()
KarelWorld	getWorld()
boolean	leftIsBlocked()
boolean	leftIsClear()
static void	main(String[] args)
boolean	menuAction(ActionEvent event) Called whenever a program action is detected in the menu bar.
void	move()
boolean	noBeepersInBag()
boolean	noBeepersPresent()
boolean	notFacingEast()
boolean	notFacingNorth()
boolean	notFacingSouth()
boolean	notFacingWest()
void	pickBeeper()
void	putBeeper()
boolean	rightIsBlocked()
boolean	rightIsClear()
void	run() Specifies the code to be executed as the program runs.
void	setBeepersInBag(int nBeepers)
void	setDirection(int dir)
void	setDisplayOneFlag(boolean flag)
void	setLocation(int x, int y)
void	setLocation(Point pt)
void	setWorld(KarelWorld world)
void	start(String[] args) Starts a KarelProgram containing this Karel instance, passing it the specified arguments.
void	turnLeft()

Methods inherited from class acm.program.Program

actionPerformed, add, addActionListeners, addActionListeners, addActionListenersToButtonsOnly, addAllActionListeners, addExitHook, addImpl, adjustmentValueChanged, alert, alert, animation, center, changedUpdate, checkCompilerFlags, checkKill, checkStartupSettings, componentAdded, componentHidden, componentMoved, componentRemoved, componentResized, componentShown, confirm, contentsChanged, createConsole, createDialogIO, createMenuBar, createParameterTable, createProgramFrame, destroy, endHook, error, error, error, exit, fileExists, fileExists, fileExistsInsideJAR, fileExistsInsideJAR, fileExistsOnDisk, fileExistsOnDisk, fileSize, fileSize, focusGained, focusLost, getAnimationDelay, getAppletStub, getArgumentArray, getBoolean, getBoolean, getBoolean, getBorder, getBottomY, getCenterLocation, getCenterX, getCenterY, getCentralRegionSize, getConsole, getDialog, getDouble, getDouble, getDouble, getDouble, getHeight, getInputModel, getInteger, getInteger, getInteger, getInteger, getJFrame, getLayout, getLine, getLine, getMainThread, getMenuBar, getOutputColor, getOutputModel, getParameter, getParameterTable, getPreferredSize, getReader, getReal, getReal, getReal, getReal, getRegionPanel, getRightX, getScreenHeight, getScreenSize, getScreenWidth, getStartupObject, getTitle, getWidth, getWindow, getWriter, getYesOrNo, hasConfiguration, init, insertUpdate, intervalAdded, intervalRemoved, isAnimated, isApplet, isAppletMode, isExitOnClose, isInitialized, isStarted, itemStateChanged, keyPressed, keyReleased, keyTyped, killMe, loadConfiguration, loadConfiguration, menuCanceled, menuDeselected, menuSelected, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, openFile, openFile, openFileFromDisk, openFileFromDisk, openFileFromJAR, openFileFromJAR, pack, pause, pauseTick, popupMenuCanceled, popupMenuWillBecomeInvisible, popupMenuWillBecomeVisible, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, printf, println, println, println, println, println, println, println, println, println, println, println, println, println, println, println, println, println, prompt, readBoolean, readBoolean, readBoolean, readDouble, readDouble, readDouble, readDouble, readInt, readInt, readInt, readInt, readLine, readLine, remove, remove, removeAll, removeFromRegion, removeMenuBar, removeUpdate, repaint, runHook, saveConfiguration, saveConfiguration, setAnimated, setAnimationDelay, setAppletStub, setBackground, setBottomY, setCenterLocation, setCenterX, setCenterY, setConsole, setDialog, setExitOnClose, setFramesPerSecond, setHeight, setInputModel, setInvisible, setJFrame, setJMenuBar, setLayout, setLocation, setLocation, setOutputColor, setOutputModel, setParameter, setParameterTable, setPauseScaleFactor, setResizable, setRightX, setShowPixelGrid, setShowPixelInfo, setSize, setStartupObject, setTitle, setWidth, setX, setY, showErrorMessage, start, startAnimation, startHook, startRun, stateChanged, stopAnimation, textValueChanged, validate, valueChanged, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowGainedFocus, windowIconified, windowLostFocus, windowOpened, windowStateChanged

Methods inherited from class javax.swing.JApplet

createRootPane, getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isRootPaneCheckingEnabled, paramString, repaint, setContentPane, setGlassPane, setLayeredPane, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.applet.Applet

getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameterInfo, isActive, isValidateRoot, newAudioClip, play, play, resize, resize, setStub, showStatus, stop

Methods inherited from class java.awt.Panel

addNotify

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getListeners, getMaximumSize, getMinimumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface stanford.karel.KarelInterface

pause

Constructor Detail

Karel

public Karel()

Method Detail

run

public void run()

Description copied from class: Program

Specifies the code to be executed as the program runs. The run method is required for applications that have a thread of control that runs even in the absence of user actions, such as a program that uses console interation or that involves animation. GUI-based programs that operate by setting up an initial configuration and then wait for user events usually do not specify a run method and supply a new definition for init instead.

Specified by:

run in interface ProgramInterface

Specified by:

run in interface Runnable

Specified by:

run in interface KarelInterface

Overrides:

run in class Program

move

public void move()

Specified by:

move in interface KarelInterface

turnLeft

public void turnLeft()

Specified by:

turnLeft in interface KarelInterface

pickBeeper

public void pickBeeper()

Specified by:

pickBeeper in interface KarelInterface

putBeeper

public void putBeeper()

Specified by:

putBeeper in interface KarelInterface

frontIsClear

public boolean frontIsClear()

Specified by:

frontIsClear in interface KarelInterface

frontIsBlocked

public boolean frontIsBlocked()

Specified by:

frontIsBlocked in interface KarelInterface

leftIsClear

public boolean leftIsClear()

Specified by:

leftIsClear in interface KarelInterface

leftIsBlocked

public boolean leftIsBlocked()

Specified by:

leftIsBlocked in interface KarelInterface

rightIsClear

public boolean rightIsClear()

Specified by:

rightIsClear in interface KarelInterface

rightIsBlocked

public boolean rightIsBlocked()

Specified by:

rightIsBlocked in interface KarelInterface

beepersPresent

public boolean beepersPresent()

Specified by:

beepersPresent in interface KarelInterface

noBeepersPresent

public boolean noBeepersPresent()

Specified by:

noBeepersPresent in interface KarelInterface

beepersInBag

public boolean beepersInBag()

Specified by:

beepersInBag in interface KarelInterface

noBeepersInBag

public boolean noBeepersInBag()

Specified by:

noBeepersInBag in interface KarelInterface

facingNorth

public boolean facingNorth()

Specified by:

facingNorth in interface KarelInterface

facingEast

public boolean facingEast()

Specified by:

facingEast in interface KarelInterface

facingSouth

public boolean facingSouth()

Specified by:

facingSouth in interface KarelInterface

facingWest

public boolean facingWest()

Specified by:

facingWest in interface KarelInterface

notFacingNorth

public boolean notFacingNorth()

Specified by:

notFacingNorth in interface KarelInterface

notFacingEast

public boolean notFacingEast()

Specified by:

notFacingEast in interface KarelInterface

notFacingSouth

public boolean notFacingSouth()

Specified by:

notFacingSouth in interface KarelInterface

notFacingWest

public boolean notFacingWest()

Specified by:

notFacingWest in interface KarelInterface

main

public static void main(String[] args)

menuAction

public boolean menuAction(ActionEvent event)

Description copied from class: Program

Called whenever a program action is detected in the menu bar. Subclasses can override this method to extend the set of menu commands recognized even in the absence of a component with keyboard focus.

Overrides:

menuAction in class Program

start

public void start(String[] args)

Starts a KarelProgram containing this Karel instance, passing it the specified arguments.

Specified by:

start in interface ProgramInterface

Overrides:

start in class Program

Parameters:

args - An array of strings passed to the program

getLocation

public Point getLocation()

Specified by:

getLocation in interface KarelInterface

Overrides:

getLocation in class Component

setLocation

public void setLocation(Point pt)

Specified by:

setLocation in interface KarelInterface

Overrides:

setLocation in class Component

setLocation

public void setLocation(int x,
                        int y)

Specified by:

setLocation in interface KarelInterface

Overrides:

setLocation in class Component

getDirection

public int getDirection()

Specified by:

getDirection in interface KarelInterface

setDirection

public void setDirection(int dir)

Specified by:

setDirection in interface KarelInterface

getBeepersInBag

public int getBeepersInBag()

Specified by:

getBeepersInBag in interface KarelInterface

setBeepersInBag

public void setBeepersInBag(int nBeepers)

Specified by:

setBeepersInBag in interface KarelInterface

getWorld

public KarelWorld getWorld()

Specified by:

getWorld in interface KarelInterface

setWorld

public void setWorld(KarelWorld world)

Specified by:

setWorld in interface KarelInterface

checkWorld

protected void checkWorld(String caller)

setDisplayOneFlag

public void setDisplayOneFlag(boolean flag)