src.com.github.aliteralmind.codelet.alter.DefaultDefaultAlterGetter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of codelet Show documentation

**Codelet**: Automated insertion of *already unit-tested* example code (its source code, console output, and input text-files) into JavaDoc using inline taglets--Codelet makes it possible to have *always accurate documentation*.

There is a newer version: 0.1.4.1

Show newest version

/*license*\
   Codelet: Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com)

   This software is dual-licensed under the:
   - Lesser General Public License (LGPL) version 3.0 or, at your option, any later version;
   - Apache Software License (ASL) version 2.0.

   Either license may be applied at your discretion. More information may be found at
   - http://en.wikipedia.org/wiki/Multi-licensing.

   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:
   - LGPL 3.0: https://www.gnu.org/licenses/lgpl-3.0.txt
   - ASL 2.0: http://www.apache.org/licenses/LICENSE-2.0.txt
\*license*/
package  com.github.aliteralmind.codelet.alter;
   import  com.github.xbn.linefilter.alter.NewTextLineAltererFor;
   import  com.github.xbn.linefilter.alter.TextLineAlterer;
   import  java.util.LinkedHashMap;
/**
   The default {@code DefaultAlterGetter} used, when none is explicitely configured.

   @since  0.1.0
   @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. {@code http://codelet.aliteralmind.com}, {@code https://github.com/aliteralmind/codelet}
 **/
public class DefaultDefaultAlterGetter implements DefaultAlterGetter  {
   private static final LinkedHashMap map = newMap();
      private static final LinkedHashMap newMap()  {
         LinkedHashMap map = new LinkedHashMap(1);
         map.put("escape_html", NewTextLineAltererFor.escapeHtml());
         return  map;
      }
   public DefaultDefaultAlterGetter()  {
   }
   /**
      Returns a map with a single entry, whose key is {@code "escape_html"}, and whose value is {@link com.github.xbn.linefilter.alter.NewTextLineAltererFor}.{@link com.github.xbn.linefilter.alter.NewTextLineAltererFor#escapeHtml() escapeHtml}().
    **/
   public LinkedHashMap getForSourceCodelet()  {
      return  map;
   }
   /**
      Returns a map with a single entry, whose key is {@code "escape_html"}, and whose value is NewTextLineAltererFor.escapeHtml().

      @return  {@link #getForSourceCodelet()}
    **/
   public LinkedHashMap getForCodeletDotOut()  {
      return  getForSourceCodelet();
   }
   /*
      Returns a map with a single entry, whose key is {@code "escape_html"}, and whose value is NewTextLineAltererFor.escapeHtml().

      @return  {@link #getForSourceCodelet()}
   public LinkedHashMap getForCodeletAndOut()  {
      return  getForSourceCodelet();
   }
    */
   /**
      Returns a map with a single entry, whose key is {@code "escape_html"}, and whose value is NewTextLineAltererFor.escapeHtml().

      @return  {@link #getForSourceCodelet()}
    **/
   public LinkedHashMap getForFileTextlet()  {
      return  getForSourceCodelet();
   }
}