From 1ab7c6b0e02cdbc2dd911bb9df8a5bc6467d0434 Mon Sep 17 00:00:00 2001 From: bculkin2442 Date: Fri, 21 Jun 2019 16:37:27 -0400 Subject: Update documentation site --- docs/apidocs/bjc/replpair/ReplError.html | 383 ------------- docs/apidocs/bjc/replpair/ReplOpts.html | 378 ------------- docs/apidocs/bjc/replpair/ReplPair.html | 623 --------------------- docs/apidocs/bjc/replpair/StageStatus.html | 367 ------------ docs/apidocs/bjc/replpair/class-use/ReplError.html | 161 ------ docs/apidocs/bjc/replpair/class-use/ReplOpts.html | 152 ----- docs/apidocs/bjc/replpair/class-use/ReplPair.html | 221 -------- .../bjc/replpair/class-use/StageStatus.html | 190 ------- docs/apidocs/bjc/replpair/package-frame.html | 27 - docs/apidocs/bjc/replpair/package-summary.html | 173 ------ docs/apidocs/bjc/replpair/package-tree.html | 147 ----- docs/apidocs/bjc/replpair/package-use.html | 159 ------ 12 files changed, 2981 deletions(-) delete mode 100644 docs/apidocs/bjc/replpair/ReplError.html delete mode 100644 docs/apidocs/bjc/replpair/ReplOpts.html delete mode 100644 docs/apidocs/bjc/replpair/ReplPair.html delete mode 100644 docs/apidocs/bjc/replpair/StageStatus.html delete mode 100644 docs/apidocs/bjc/replpair/class-use/ReplError.html delete mode 100644 docs/apidocs/bjc/replpair/class-use/ReplOpts.html delete mode 100644 docs/apidocs/bjc/replpair/class-use/ReplPair.html delete mode 100644 docs/apidocs/bjc/replpair/class-use/StageStatus.html delete mode 100644 docs/apidocs/bjc/replpair/package-frame.html delete mode 100644 docs/apidocs/bjc/replpair/package-summary.html delete mode 100644 docs/apidocs/bjc/replpair/package-tree.html delete mode 100644 docs/apidocs/bjc/replpair/package-use.html (limited to 'docs/apidocs/bjc/replpair') diff --git a/docs/apidocs/bjc/replpair/ReplError.html b/docs/apidocs/bjc/replpair/ReplError.html deleted file mode 100644 index 5204357..0000000 --- a/docs/apidocs/bjc/replpair/ReplError.html +++ /dev/null @@ -1,383 +0,0 @@ - - - - - - -ReplError (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - - -
-
bjc.replpair
-

Class ReplError

-
-
- -
-
    -
  • -
    -
    -
    public class ReplError
    -extends Object
    -
    Represents an error encountered parsing ReplPairs
    -
    -
    Author:
    -
    Ben Culkin
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        line

        -
        public int line
        -
        The line the error occured on.
        -
      • -
      - - - -
        -
      • -

        numPairs

        -
        public int numPairs
        -
        The number of pairs we have processed so far.
        -
      • -
      - - - -
        -
      • -

        txt

        -
        public String txt
        -
        The text of the line we errored on.
        -
      • -
      - - - -
        -
      • -

        msg

        -
        public String msg
        -
        The message of the error.
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ReplError

        -
        public ReplError(int lne,
        -                 int nPairs,
        -                 String msg,
        -                 String txt)
        -
        Create a new ReplPair parse error.
        -
        -
        Parameters:
        -
        lne - The line the error occured on.
        -
        nPairs - The number of pairs processed up to this point.
        -
        msg - The message detailing the error.
        -
        txt - The text that caused the error.
        -
        -
      • -
      -
    • -
    - - -
  • -
-
-
- - -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - diff --git a/docs/apidocs/bjc/replpair/ReplOpts.html b/docs/apidocs/bjc/replpair/ReplOpts.html deleted file mode 100644 index 2da743b..0000000 --- a/docs/apidocs/bjc/replpair/ReplOpts.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - - -ReplOpts (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - - -
-
bjc.replpair
-

Class ReplOpts

-
-
- -
-
    -
  • -
    -
    -
    public class ReplOpts
    -extends Object
    -
    Options for processing ReplPairs.
    -
    -
    Author:
    -
    Ben Culkin.
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        defPrior

        -
        public int defPrior
        -
        The default priority.
        -
      • -
      - - - -
        -
      • -

        defStage

        -
        public int defStage
        -
        The default stage.
        -
      • -
      - - - -
        -
      • -

        defMulti

        -
        public boolean defMulti
        -
        Whether to process multi-line defns.
        -
      • -
      - - - -
        -
      • -

        defStatus

        -
        public StageStatus defStatus
        -
        Default status.
        -
      • -
      - - - -
        -
      • -

        isDebug

        -
        public boolean isDebug
        -
        Enable debug info.
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ReplOpts

        -
        public ReplOpts()
        -
        Create a default set of options.
        -
      • -
      - - - -
        -
      • -

        ReplOpts

        -
        public ReplOpts(int p,
        -                int s,
        -                boolean m,
        -                StageStatus t,
        -                boolean d)
        -
        Create a new set of repl. opts
        -
        -
        Parameters:
        -
        p - The default priority to use
        -
        s - The default stage to use
        -
        m - Whether to process multi-line defns.
        -
        t - The default status.
        -
        -
      • -
      -
    • -
    -
  • -
-
-
- - -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - diff --git a/docs/apidocs/bjc/replpair/ReplPair.html b/docs/apidocs/bjc/replpair/ReplPair.html deleted file mode 100644 index fff44ec..0000000 --- a/docs/apidocs/bjc/replpair/ReplPair.html +++ /dev/null @@ -1,623 +0,0 @@ - - - - - - -ReplPair (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - - -
-
bjc.replpair
-

Class ReplPair

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        priority

        -
        public int priority
        -
        The priority for this replacement.
        -
      • -
      - - - -
        -
      • -

        name

        -
        public String name
        -
        The name of this replacement. - - Defaults to the 'find' string.
        -
      • -
      - - - -
        -
      • -

        find

        -
        public String find
        -
        The string to look for.
        -
      • -
      - - - -
        -
      • -

        replace

        -
        public String replace
        -
        The string to replace it with.
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ReplPair

        -
        public ReplPair()
        -
        Create a new blank replacement pair.
        -
      • -
      - - - -
        -
      • -

        ReplPair

        -
        public ReplPair(String f,
        -                String r)
        -
        Create a new replacement pair with a priority of 1.
        -
        -
        Parameters:
        -
        f - The string to find.
        -
        r - The string to replace.
        -
        -
      • -
      - - - -
        -
      • -

        ReplPair

        -
        public ReplPair(String f,
        -                String r,
        -                String n)
        -
        Create a new named replacement pair with a priority of 1.
        -
        -
        Parameters:
        -
        f - The string to find.
        -
        r - The string to replace.
        -
        n - The name of the replacement pair.
        -
        -
      • -
      - - - -
        -
      • -

        ReplPair

        -
        public ReplPair(String f,
        -                String r,
        -                int p)
        -
        Create a new replacement pair with a set priority.
        -
        -
        Parameters:
        -
        f - The string to find.
        -
        r - The string to replace.
        -
        p - The priority for the replacement.
        -
        -
      • -
      - - - -
        -
      • -

        ReplPair

        -
        public ReplPair(String f,
        -                String r,
        -                int p,
        -                String n)
        -
        Create a new replacement pair with a set priority and name.
        -
        -
        Parameters:
        -
        f - The string to find.
        -
        r - The string to replace.
        -
        n - The name of the replacement pair.
        -
        p - The priority for the replacement.
        -
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        readList

        -
        public static List<ReplPair> readList(Scanner scn)
        -
        Read a list of replacement pairs from an input source.
        -
        -
        Parameters:
        -
        scn - The source to read the replacements from.
        -
        Returns:
        -
        The list of replacements.
        -
        -
      • -
      - - - -
        -
      • -

        readList

        -
        public static List<ReplPair> readList(List<ReplPair> detals,
        -                                      Scanner scn)
        -
        Read a list of replacement pairs from an input source, adding them to - an existing list.
        -
        -
        Parameters:
        -
        detals - The list to add the replacements to.
        -
        scn - The source to read the replacements from.
        -
        Returns:
        -
        The list of replacements.
        -
        -
      • -
      - - - -
        -
      • -

        readList

        -
        public static List<ReplPair> readList(List<ReplPair> detals,
        -                                      Scanner scn,
        -                                      List<ReplError> errs)
        -
        Read a list of replacement pairs from an input source, adding them to - an existing list.
        -
        -
        Parameters:
        -
        detals - The list to add the replacements to.
        -
        scn - The source to read the replacements from.
        -
        errs - The list to stick errors in.
        -
        Returns:
        -
        The list of replacements.
        -
        -
      • -
      - - - - - - - - - - - - - - - - -
    • -
    -
  • -
-
-
- - -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - diff --git a/docs/apidocs/bjc/replpair/StageStatus.html b/docs/apidocs/bjc/replpair/StageStatus.html deleted file mode 100644 index c6f0c08..0000000 --- a/docs/apidocs/bjc/replpair/StageStatus.html +++ /dev/null @@ -1,367 +0,0 @@ - - - - - - -StageStatus (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - - -
-
bjc.replpair
-

Enum StageStatus

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        INTERNAL

        -
        public static final StageStatus INTERNAL
        -
        Only use for staging pairs; don't export.
        -
      • -
      - - - -
        -
      • -

        EXTERNAL

        -
        public static final StageStatus EXTERNAL
        -
        Don't use for staging pairs; do export.
        -
      • -
      - - - -
        -
      • -

        BOTH

        -
        public static final StageStatus BOTH
        -
        Use for staging pairs; do export.
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static StageStatus[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (StageStatus c : StageStatus.values())
        -    System.out.println(c);
        -
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
      • -
      - - - -
        -
      • -

        valueOf

        -
        public static StageStatus valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
      • -
      -
    • -
    -
  • -
-
-
- - -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - diff --git a/docs/apidocs/bjc/replpair/class-use/ReplError.html b/docs/apidocs/bjc/replpair/class-use/ReplError.html deleted file mode 100644 index 60ad3ca..0000000 --- a/docs/apidocs/bjc/replpair/class-use/ReplError.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - -Uses of Class bjc.replpair.ReplError (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - -
-

Uses of Class
bjc.replpair.ReplError

-
-
- -
- -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - diff --git a/docs/apidocs/bjc/replpair/class-use/ReplOpts.html b/docs/apidocs/bjc/replpair/class-use/ReplOpts.html deleted file mode 100644 index aa7ca94..0000000 --- a/docs/apidocs/bjc/replpair/class-use/ReplOpts.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - -Uses of Class bjc.replpair.ReplOpts (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - -
-

Uses of Class
bjc.replpair.ReplOpts

-
-
- -
- -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - diff --git a/docs/apidocs/bjc/replpair/class-use/ReplPair.html b/docs/apidocs/bjc/replpair/class-use/ReplPair.html deleted file mode 100644 index 2bb6311..0000000 --- a/docs/apidocs/bjc/replpair/class-use/ReplPair.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - - -Uses of Class bjc.replpair.ReplPair (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - -
-

Uses of Class
bjc.replpair.ReplPair

-
-
- -
- -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - diff --git a/docs/apidocs/bjc/replpair/class-use/StageStatus.html b/docs/apidocs/bjc/replpair/class-use/StageStatus.html deleted file mode 100644 index 28239ee..0000000 --- a/docs/apidocs/bjc/replpair/class-use/StageStatus.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - -Uses of Class bjc.replpair.StageStatus (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - -
-

Uses of Class
bjc.replpair.StageStatus

-
-
- -
- -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - diff --git a/docs/apidocs/bjc/replpair/package-frame.html b/docs/apidocs/bjc/replpair/package-frame.html deleted file mode 100644 index 5545ec3..0000000 --- a/docs/apidocs/bjc/replpair/package-frame.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - -bjc.replpair (everge 1.0-SNAPSHOT API) - - - - - -

bjc.replpair

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/apidocs/bjc/replpair/package-summary.html b/docs/apidocs/bjc/replpair/package-summary.html deleted file mode 100644 index 545f70d..0000000 --- a/docs/apidocs/bjc/replpair/package-summary.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - -bjc.replpair (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - -
-

Package bjc.replpair

-
-
- -
- -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - diff --git a/docs/apidocs/bjc/replpair/package-tree.html b/docs/apidocs/bjc/replpair/package-tree.html deleted file mode 100644 index 9b16b77..0000000 --- a/docs/apidocs/bjc/replpair/package-tree.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - -bjc.replpair Class Hierarchy (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - -
-

Hierarchy For Package bjc.replpair

-
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - diff --git a/docs/apidocs/bjc/replpair/package-use.html b/docs/apidocs/bjc/replpair/package-use.html deleted file mode 100644 index 8e93ee5..0000000 --- a/docs/apidocs/bjc/replpair/package-use.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - -Uses of Package bjc.replpair (everge 1.0-SNAPSHOT API) - - - - - - - - -
- - - - - - - -
- - -
-

Uses of Package
bjc.replpair

-
-
- -
- -
- - - - - - - -
- - -

Copyright © 2019. All rights reserved.

- - -- cgit v1.2.3