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/**
017   <p>Defines &quot;user-created extra&quot; gaps that may be added to Codelet templates. The fully-qualified class name of your implementation is specified in the {@link com.github.aliteralmind.codelet.CodeletBaseConfig#USER_EXTRA_GAPS_CLASS_NAME user_extra_gaps_class} configuration variable.</p>
018
019   <p><b>Implementation requirements:</b><ul>
020        <li>All functions must return a non-{@code null} array, where no element is {@code null}, and every {@linkplain com.github.xbn.keyed.Named#getName() name} is unique and not equal to any of the required or &quot;optional-default&quot; gaps for its Codelet type.</li>
021        <li>There must be a no-parameter constructor.</li>
022   </ul>
023
024 * @since  0.1.0
025 * @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>
026 **/
027public interface UserExtraGapGetter  {
028   /**
029        <p>Extra gap-filler objects for (source-code) {@link com.github.aliteralmind.codelet.CodeletType#SOURCE_CODE {@.codelet}} taglets, when {@linkplain UserExtraGapGetter configured}.</p>
030
031        @return  A non-{@code null} array, where no element is {@code null}, and every {@linkplain com.github.xbn.keyed.Named#getName() name} is unique and not equal to any of the <a href="{@docRoot}/com/github/aliteralmind/codelet/type/SourceCodeTemplate.html">required or &quot;optional-default&quot; gaps</a> for this Codelet type.
032        @see  #getForCodeletDotOut()
033        @see  #getForCodeletAndOut()
034        @see  #getForFileTextlet()
035    **/
036   CodeletGap[] getForSourceCodelet();
037   /**
038        <p>Extra gap-filler objects for {@link com.github.aliteralmind.codelet.CodeletType#CONSOLE_OUT {@.codelet.out}} taglets, when {@linkplain UserExtraGapGetter configured}.</p>
039
040        @return  A non-{@code null} array, where no element is {@code null}, and every {@linkplain com.github.xbn.keyed.Named#getName() name} is unique and not equal to any of the <a href="{@docRoot}/com/github/aliteralmind/codelet/type/ConsoleOutTemplate.html">required or &quot;optional-default&quot; gaps</a> for this Codelet type.
041        @see  #getForSourceCodelet()
042    **/
043   CodeletGap[] getForCodeletDotOut();
044   /**
045        <p>Extra gap-filler objects for {@link com.github.aliteralmind.codelet.CodeletType#SOURCE_AND_OUT {@.codelet.and.out}} taglets, when {@linkplain UserExtraGapGetter configured}.</p>
046
047        @return  A non-{@code null} array, where no element is {@code null}, and every {@linkplain com.github.xbn.keyed.Named#getName() name} is unique and not equal to any of the <a href="{@docRoot}/com/github/aliteralmind/codelet/type/SourceAndOutTemplate.html">required or &quot;optional-default&quot; gaps</a> for this Codelet type.
048        @see  #getForSourceCodelet()
049    **/
050   CodeletGap[] getForCodeletAndOut();
051   /**
052        <p>Extra gap-filler objects for {@link com.github.aliteralmind.codelet.CodeletType#FILE_TEXT {@.file.textlet}} taglets, when {@linkplain UserExtraGapGetter configured}.</p>
053
054        @return  A non-{@code null} array, where no element is {@code null}, and every {@linkplain com.github.xbn.keyed.Named#getName() name} is unique and not equal to any of the <a href="{@docRoot}/com/github/aliteralmind/codelet/type/FileTextTemplate.html">required or &quot;optional-default&quot; gaps</a> for this Codelet type.
055        @see  #getForSourceCodelet()
056    **/
057   CodeletGap[] getForFileTextlet();
058}