001/*license*\
002   Codelet: Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com)
003
004   This software is dual-licensed under the:
005   - Lesser General Public License (LGPL) version 3.0 or, at your option, any later version;
006   - Apache Software License (ASL) version 2.0.
007
008   Either license may be applied at your discretion. More information may be found at
009   - http://en.wikipedia.org/wiki/Multi-licensing.
010
011   The text of both licenses is available in the root directory of this project, under the names "LICENSE_lgpl-3.0.txt" and "LICENSE_asl-2.0.txt". The latest copies may be downloaded at:
012   - LGPL 3.0: https://www.gnu.org/licenses/lgpl-3.0.txt
013   - ASL 2.0: http://www.apache.org/licenses/LICENSE-2.0.txt
014\*license*/
015package  com.github.aliteralmind.codelet;
016   import  com.github.xbn.keyed.SimpleNamed;
017/**
018   <p>A single gap in a Codelet template, including a function that fills it based on the Codelet instance and global configuration.</p>
019
020   @see  com.github.aliteralmind.codelet.type.SourceCodeTemplate type.SourceCodeTemplate
021   @see  com.github.aliteralmind.codelet.type.ConsoleOutTemplate type.ConsoleOutTemplate
022   @see  com.github.aliteralmind.codelet.type.SourceAndOutTemplate type.SourceAndOutTemplate
023   @see  com.github.aliteralmind.codelet.type.FileTextTemplate type.FileTextTemplate
024   @see  com.github.aliteralmind.codelet.UserExtraGapGetter UserExtraGapGetter
025 * @since  0.1.0
026 * @author  Copyright (C) 2014, Jeff Epstein ({@code aliteralmind __DASH__ github __AT__ yahoo __DOT__ com}), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. <a href="http://codelet.aliteralmind.com">{@code http://codelet.aliteralmind.com}</a>, <a href="https://github.com/aliteralmind/codelet">{@code https://github.com/aliteralmind/codelet}</a>
027 **/
028public abstract class CodeletGap extends SimpleNamed  {
029   /**
030        <p>Create a new instance with a name.</p>
031
032        <p>Equal to {@link com.github.xbn.keyed.SimpleNamed#SimpleNamed(String) super}{@code (name)}</p>
033
034        @param  name  May not be {@code null} or empty, and must contain only letters, digits, and underscores. Get with {@link com.github.xbn.keyed.Named#getName() getName}{@code ()}*.
035    **/
036   public CodeletGap(String name)  {
037      super(name);
038   }
039   /**
040      <p>The output string that replaces the gap.</p>
041
042    * @param  instance  The codelet instance. May not be {@code null}. <i>When creating a ...custom gap... you do not need to check (or try-catch) for {@code null}-ness.</i>
043    * @return  A non-{@code null} string.
044    */
045   public abstract String getFillText(CodeletInstance instance);
046}