1 /*
   2  * Copyright (c) 1996, 1999, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.awt;
  27 
  28 /**
  29  * The {@code Stroke} interface allows a
  30  * {@link Graphics2D} object to obtain a {@link Shape} that is the
  31  * decorated outline, or stylistic representation of the outline,
  32  * of the specified {@code Shape}.
  33  * Stroking a {@code Shape} is like tracing its outline with a
  34  * marking pen of the appropriate size and shape.
  35  * The area where the pen would place ink is the area enclosed by the
  36  * outline {@code Shape}.
  37  * <p>
  38  * The methods of the {@code Graphics2D} interface that use the
  39  * outline {@code Shape} returned by a {@code Stroke} object
  40  * include {@code draw} and any other methods that are
  41  * implemented in terms of that method, such as
  42  * {@code drawLine}, {@code drawRect},
  43  * {@code drawRoundRect}, {@code drawOval},
  44  * {@code drawArc}, {@code drawPolyline},
  45  * and {@code drawPolygon}.
  46  * <p>
  47  * The objects of the classes implementing {@code Stroke}
  48  * must be read-only because {@code Graphics2D} does not
  49  * clone these objects either when they are set as an attribute
  50  * with the {@code setStroke} method or when the
  51  * {@code Graphics2D} object is itself cloned.
  52  * If a {@code Stroke} object is modified after it is set in
  53  * the {@code Graphics2D} context then the behavior
  54  * of subsequent rendering would be undefined.
  55  * @see BasicStroke
  56  * @see Graphics2D#setStroke
  57  */
  58 public interface Stroke {
  59     /**
  60      * Returns an outline {@code Shape} which encloses the area that
  61      * should be painted when the {@code Shape} is stroked according
  62      * to the rules defined by the
  63      * object implementing the {@code Stroke} interface.
  64      * @param p a {@code Shape} to be stroked
  65      * @return the stroked outline {@code Shape}.
  66      */
  67     Shape createStrokedShape (Shape p);
  68 }
--- EOF ---