jakarta-oro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d..@apache.org
Subject cvs commit: jakarta-oro/src/java/org/apache/oro/text/regex PatternCompilerOptions.java PatternMatchingEngine.java
Date Tue, 15 Jun 2004 00:56:17 GMT
dfs         2004/06/14 17:56:17

  Modified:    .        TODO
               src/java/org/apache/oro/text/regex
                        PatternCompilerOptions.java
                        PatternMatchingEngine.java
  Log:
  Wrote brief javadocs for PatternCompilerOptions and PatternMatchingEngine.
  
  Revision  Changes    Path
  1.20      +2 -4      jakarta-oro/TODO
  
  Index: TODO
  ===================================================================
  RCS file: /home/cvs/jakarta-oro/TODO,v
  retrieving revision 1.19
  retrieving revision 1.20
  diff -u -r1.19 -r1.20
  --- TODO	18 Feb 2004 06:46:03 -0000	1.19
  +++ TODO	15 Jun 2004 00:56:17 -0000	1.20
  @@ -1,8 +1,6 @@
   $Id$
   
  -o document the following classes if we keep them:
  -  PatternMatchingEngine
  -  PatternCompilerOptions
  +o document the following classes:
     Perl5Engine
     Perl5CompilerOptions
     AwkEngine
  
  
  
  1.2       +29 -2     jakarta-oro/src/java/org/apache/oro/text/regex/PatternCompilerOptions.java
  
  Index: PatternCompilerOptions.java
  ===================================================================
  RCS file: /home/cvs/jakarta-oro/src/java/org/apache/oro/text/regex/PatternCompilerOptions.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- PatternCompilerOptions.java	18 Feb 2004 06:44:21 -0000	1.1
  +++ PatternCompilerOptions.java	15 Jun 2004 00:56:17 -0000	1.2
  @@ -21,15 +21,42 @@
   
   
   /**
  - * 
  + * PatternCompilerOptions abstracts the options used by regular
  + * expression engines into a common set.  These options are
  + * represented as integer constants that must be mapped to a value
  + * native to the regular expression implementation.
  + *
    * @version @version@
    * @since 2.1
    */
   public interface PatternCompilerOptions {
   
  +  /**
  +   * The default set of options used by a {@link PatternCompiler}.
  +   */
     public int DEFAULT          = 0;
  +
  +  /**
  +   * An option indicating a compiled regular expression should be case
  +   * insensitive.
  +   */
     public int CASE_INSENSITIVE = 1;
  +
  +  /**
  +   * An option indicating a compiled regular expression should treat
  +   * input as having multiple lines.
  +   */
     public int MULTILINE        = 2;
  +
  +  /**
  +   * Maps one of the PatternCompilerOptions constants to a mask value
  +   * that can be passed to a {@link PatternCompiler} implementation to
  +   * compile a pattern.
  +   *
  +   * @param option A PatternCompilerOptions option constant.
  +   * @return The mask value specific to the regular expression engine
  +   *         that corresponds to the option parameter.
  +   */
   
     public int getMask(int option)
       throws UnsupportedOperationException;
  
  
  
  1.2       +29 -1     jakarta-oro/src/java/org/apache/oro/text/regex/PatternMatchingEngine.java
  
  Index: PatternMatchingEngine.java
  ===================================================================
  RCS file: /home/cvs/jakarta-oro/src/java/org/apache/oro/text/regex/PatternMatchingEngine.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- PatternMatchingEngine.java	18 Feb 2004 06:44:21 -0000	1.1
  +++ PatternMatchingEngine.java	15 Jun 2004 00:56:17 -0000	1.2
  @@ -21,15 +21,43 @@
   
   
   /**
  + * PatternMatchingEngine is an interface that abstracts a regular
  + * expression implementation into a {@link PatternCompiler}, a
  + * {@link PatternMatcher}, and {@link PatternCompilerOptions}.
  + * Implementations of PatternMatchingEngine can wrap any regular
  + * expression implementation and make them usable using the
  + * jakarta-oro interfaces.
    * 
    * @version @version@
    * @since 2.1
    */
   public interface PatternMatchingEngine {
   
  +  /**
  +   * Creates a new instance of a PatternCompiler that can compile
  +   * patterns for a particular regular expression engine.
  +   *
  +   * @return A new PatternCompiler.
  +   */
  +
     public PatternCompiler createCompiler();
   
  +  /**
  +   * Creates a new instance of a PatternMatcher that can match
  +   * patterns for a particular regular expression engine.
  +   *
  +   * @return A new PatternMatcher.
  +   */
  +
     public PatternMatcher createMatcher();
  +
  +  /**
  +   * Returns a {@link PatternCompilerOptions} object that can map
  +   * generic {@link PatternCompilerOptions} option constants into
  +   * constants specific to a particular regular expression engine.
  +   *
  +   * @return A PatternCompilerOptions object corresponding to an engine.
  +   */
   
     public PatternCompilerOptions getOptions();
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: oro-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: oro-dev-help@jakarta.apache.org


Mime
View raw message