You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doxia-commits@maven.apache.org by vs...@apache.org on 2008/03/01 01:29:20 UTC
svn commit: r632507 -
/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/
Author: vsiveton
Date: Fri Feb 29 16:29:17 2008
New Revision: 632507
URL: http://svn.apache.org/viewvc?rev=632507&view=rev
Log:
DOXIA-217: Make default internal classes
o updated also some javadoc
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AbstractFatherBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AnchorBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/Block.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BlockParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BoldBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/FormatedTextParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HRuleBlockParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HorizontalRuleBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ItalicBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/LinkBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListItemBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/MonospaceBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NopBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NumeratedListBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlockParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlockParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlockParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellHeaderBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableRowBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/UnorderedListBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlockParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordLinkResolver.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/XHTMLWikiWordLinkResolver.java
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AbstractFatherBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AbstractFatherBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AbstractFatherBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AbstractFatherBlock.java Fri Feb 29 16:29:17 2008
@@ -23,14 +23,13 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Generic Block for the Block that have child blocks.
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
-public abstract class AbstractFatherBlock implements Block
+abstract class AbstractFatherBlock implements Block
{
/**
* @see AbstractFatherBlock#AbstractFatherBlock(Block[])
@@ -42,21 +41,21 @@
*
* @param sink a sink to fill
*/
- public abstract void before( Sink sink );
+ abstract void before( Sink sink );
/**
* method called after traversing the childs
*
* @param sink a sink to fill
*/
- public abstract void after( Sink sink );
+ abstract void after( Sink sink );
/**
* Creates the AbstractFatherBlock.
*
* @param childBlocks child blocks
*/
- public AbstractFatherBlock( final Block[] childBlocks )
+ AbstractFatherBlock( final Block[] childBlocks )
{
if ( childBlocks == null )
{
@@ -74,16 +73,14 @@
this.childBlocks = childBlocks;
}
- /**
- * @see Block#traverse(org.apache.maven.doxia.sink.Sink)
- */
+ /** {@inheritDoc} */
public final void traverse( final Sink sink )
{
before( sink );
for ( int i = 0; i < childBlocks.length; i++ )
{
Block block = childBlocks[i];
-
+
block.traverse( sink );
}
after( sink );
@@ -99,10 +96,7 @@
return childBlocks;
}
- /**
- * @see Object#equals(Object)
- */
- // CHECKSTYLE:DESIGN:OFF
+ /** {@inheritDoc}*/
public boolean equals( final Object obj )
{
boolean ret = false;
@@ -127,9 +121,7 @@
return ret;
}
- /**
- * @see Object#hashCode()
- */
+ /** {@inheritDoc}*/
public int hashCode()
{
int result = 1;
@@ -140,8 +132,7 @@
result += childBlocks[i].hashCode();
}
}
-
+
return result;
}
- // CHECKSTYLE:DESIGN:ON
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AnchorBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AnchorBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AnchorBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AnchorBlock.java Fri Feb 29 16:29:17 2008
@@ -26,9 +26,9 @@
* Represents an anchor
*
* @author Juan F. Codagnone
- * @since Nov 5, 2005
+ * @version $Id$
*/
-public class AnchorBlock implements Block
+class AnchorBlock implements Block
{
/**
* anchor name
@@ -41,7 +41,7 @@
* @param name name of the anchor
* @throws IllegalArgumentException if the arguments are <code>null</code>
*/
- public AnchorBlock( final String name ) throws IllegalArgumentException
+ AnchorBlock( final String name ) throws IllegalArgumentException
{
if ( name == null )
{
@@ -50,18 +50,14 @@
this.name = name;
}
- /**
- * @see Block#traverse(org.apache.maven.doxia.sink.Sink)
- */
+ /** {@inheritDoc}*/
public final void traverse( final Sink sink )
{
sink.anchor( name );
sink.anchor_();
}
- /**
- * @see Object#equals(Object)
- */
+ /** {@inheritDoc}*/
public final boolean equals( final Object obj )
{
boolean ret = false;
@@ -80,9 +76,7 @@
return ret;
}
- /**
- * @see Object#hashCode()
- */
+ /** {@inheritDoc}*/
public final int hashCode()
{
return name.hashCode();
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/Block.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/Block.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/Block.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/Block.java Fri Feb 29 16:29:17 2008
@@ -28,11 +28,10 @@
* Implementators should implement equals() and hashCode() to ease testing
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
public interface Block
{
-
/**
* Traverse the block
*
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BlockParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BlockParser.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BlockParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BlockParser.java Fri Feb 29 16:29:17 2008
@@ -26,11 +26,10 @@
* Parse a twiki syntax block
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
public interface BlockParser
{
-
/**
* @param line text line
* @return <code>true</code> if this class can handle this line
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BoldBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BoldBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BoldBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BoldBlock.java Fri Feb 29 16:29:17 2008
@@ -21,16 +21,14 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Block that represents the bold text format
*
* @author Juan F. Codagnone
- * @since Nov 2, 2005
+ * @version $Id$
*/
public class BoldBlock extends AbstractFatherBlock
{
-
/**
* Creates the BoldBlock.
*
@@ -41,20 +39,15 @@
super( childBlocks );
}
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.bold();
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.bold_();
}
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/FormatedTextParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/FormatedTextParser.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/FormatedTextParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/FormatedTextParser.java Fri Feb 29 16:29:17 2008
@@ -26,7 +26,7 @@
* Parse looking for formated text (bold, italic, ...)
*
* @author Juan F. Codagnone
- * @since Nov 2, 2005
+ * @version $Id$
*/
public class FormatedTextParser
{
@@ -46,50 +46,59 @@
private static final FormatBlockFactory BOLD_FACTORY =
new FormatBlockFactory()
{
+ /** {@inheritDoc} */
public Block createBlock( final Block [] childrens )
{
return new BoldBlock( childrens );
}
};
+
/**
* creates italic blocks
*/
private static final FormatBlockFactory ITALIC_FACTORY =
new FormatBlockFactory()
{
+ /** {@inheritDoc} */
public Block createBlock( final Block [] childrens )
{
return new ItalicBlock( childrens );
}
};
+
/**
* creates monospaced blocks
*/
private static final FormatBlockFactory MONOSPACED_FACTORY =
new FormatBlockFactory()
{
+ /** {@inheritDoc} */
public Block createBlock( final Block [] childrens )
{
return new MonospaceBlock( childrens );
}
};
+
/**
* creates bold italic blocks
*/
private static final FormatBlockFactory BOLDITALIC_FACTORY =
new FormatBlockFactory()
{
+ /** {@inheritDoc} */
public Block createBlock( final Block [] childrens )
{
return new BoldBlock( new Block[]{new ItalicBlock( childrens )} );
}
};
+
/**
* creates bold monospace blocks
*/
private static final FormatBlockFactory BOLDMONO_FACTORY =
new FormatBlockFactory()
{
+ /** {@inheritDoc} */
public Block createBlock( final Block [] childrens )
{
return new BoldBlock( new Block[]{
@@ -118,7 +127,7 @@
* @param line line to parse
* @return TextBlock, ItalicBlock, BoldBlock, MonospacedBlock, ...
*/
- public final Block []parse( final String line )
+ final Block []parse( final String line )
{
return (Block[]) parseFormat( line ).toArray( new Block []{} );
}
@@ -127,7 +136,7 @@
* @param c character to test
* @return <code>true</code> if c is a space character
*/
- private static boolean isSpace( final char c )
+ static boolean isSpace( final char c )
{
return c == ' ' || c == '\t';
}
@@ -136,7 +145,7 @@
* @param c character to test
* @return <code>true</code> if c is a character that limits the formats
*/
- private static boolean isSpecial( final char c )
+ static boolean isSpecial( final char c )
{
boolean ret = false;
@@ -165,7 +174,7 @@
final int []lhOffsets = new int[SPECIAL_CHAR.length];
final int []rhOffsets = new int[SPECIAL_CHAR.length];
- // for each text format markers...
+ // for each text format markers...
for ( int i = 0; i < SPECIAL_CHAR.length; i++ )
{
final int specialLen = SPECIAL_CHAR[i].length();
@@ -173,11 +182,11 @@
// search the nearset instance of this marker...
while ( t != -1 && ( t = line.indexOf( SPECIAL_CHAR[i], t ) ) != -1 )
{
- // and check if it at the begining of a word.
- if ( t == 0 || isSpace( line.charAt( t - 1 ) )
+ // and check if it at the begining of a word.
+ if ( t == 0 || isSpace( line.charAt( t - 1 ) )
|| isParenthesis( line.charAt( t - 1 ) ) )
{
- // if it is, and if, check to avoid going beyond the string
+ // if it is, and if, check to avoid going beyond the string
if ( t + specialLen < line.length() )
{
// and if character after the format marker is another
@@ -297,7 +306,7 @@
/**
* @author Juan F. Codagnone
- * @since Nov 3, 2005
+ * @version $Id$
*/
interface FormatBlockFactory
{
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java Fri Feb 29 16:29:17 2008
@@ -33,7 +33,7 @@
* Generic list parser
*
* @author Juan F. Codagnone
- * @since Nov 9, 2005
+ * @version $Id$
*/
public class GenericListBlockParser implements BlockParser
{
@@ -60,9 +60,7 @@
}
}
- /**
- * @see BlockParser#accept(String)
- */
+ /** {@inheritDoc} */
public final boolean accept( final String line )
{
boolean ret = false;
@@ -75,9 +73,7 @@
return ret;
}
- /**
- * @see BlockParser#visit(String,org.apache.maven.doxia.util.ByLineSource)
- */
+ /** {@inheritDoc} */
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
@@ -132,153 +128,129 @@
}
this.formatedTextParser = textParser;
}
-
- public interface Type
+
+ interface Type
{
/**
* @return the pattern of the item part of the list regex
*/
String getItemPattern();
-
+
/**
* @param items children of the new listblock
* @return a new ListBlock
*/
ListBlock createList( final ListItemBlock []items );
-
+
}
-
+
/**
* unordered list
*/
private static final Type LIST = new Type() {
- /**
- * @see Type#getItemPattern()
- */
+ /** {@inheritDoc} */
public String getItemPattern()
{
return "[*]";
}
- /**
- * @see Type#createList(ListItemBlock)
- */
+ /** {@inheritDoc} */
public ListBlock createList( final ListItemBlock []items )
{
return new UnorderedListBlock( items );
}
};
-
+
/**
* a.
*/
private static final Type ORDERED_LOWER_ALPHA = new Type() {
- /**
- * @see Type#getItemPattern()
- */
+ /** {@inheritDoc} */
public String getItemPattern()
{
return "[a-hj-z][.]";
}
- /**
- * @see Type#createList(ListItemBlock)
- */
+ /** {@inheritDoc} */
public ListBlock createList( final ListItemBlock []items )
{
return new NumeratedListBlock( Sink.NUMBERING_LOWER_ALPHA,
items );
}
};
-
+
/**
* A.
*/
private static final Type ORDERED_UPPER_ALPHA = new Type() {
- /**
- * @see Type#getItemPattern()
- */
+ /** {@inheritDoc} */
public String getItemPattern()
{
return "[A-HJ-Z][.]";
}
- /**
- * @see Type#createList(ListItemBlock)
- */
+ /** {@inheritDoc} */
public ListBlock createList( final ListItemBlock []items )
{
return new NumeratedListBlock( Sink.NUMBERING_UPPER_ALPHA,
items );
}
};
-
+
/**
* 1.
*/
private static final Type ORDERERED_DECIMAL = new Type(){
- /**
- * @see Type#getItemPattern()
- */
+ /** {@inheritDoc} */
public String getItemPattern()
{
return "[0123456789][.]";
}
- /**
- * @see Type#createList(ListItemBlock)
- */
+ /** {@inheritDoc} */
public ListBlock createList( final ListItemBlock []items )
{
return new NumeratedListBlock( Sink.NUMBERING_DECIMAL,
items );
}
};
-
+
/**
* i.
*/
private static final Type ORDERERED_LOWER_ROMAN = new Type(){
- /**
- * @see Type#getItemPattern()
- */
+ /** {@inheritDoc} */
public String getItemPattern()
{
return "[i][.]";
}
- /**
- * @see Type#createList(ListItemBlock)
- */
+ /** {@inheritDoc} */
public ListBlock createList( final ListItemBlock []items )
{
return new NumeratedListBlock( Sink.NUMBERING_LOWER_ROMAN,
items );
}
};
-
+
/**
* I.
*/
private static final Type ORDERERED_UPPER_ROMAN = new Type(){
- /**
- * @see Type#getItemPattern()
- */
+ /** {@inheritDoc} */
public String getItemPattern()
{
return "[I][.]";
}
- /**
- * @see Type#createList(ListItemBlock)
- */
+ /** {@inheritDoc} */
public ListBlock createList( final ListItemBlock []items )
{
return new NumeratedListBlock( Sink.NUMBERING_UPPER_ROMAN,
items );
}
};
-
+
private static final Type[] TYPES = {
LIST, ORDERED_LOWER_ALPHA, ORDERED_UPPER_ALPHA, ORDERERED_DECIMAL, ORDERERED_LOWER_ROMAN, ORDERERED_UPPER_ROMAN
};
@@ -289,7 +261,7 @@
* It helps to build
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
class TreeListBuilder
{
@@ -306,14 +278,13 @@
*/
private TreeComponent current;
-
/**
* Creates the TreeListBuilder.
*
* @param formatTextParser parser that create text blocks
* @throws IllegalArgumentException if <code>formatTextParser</code> is null
*/
- public TreeListBuilder( final FormatedTextParser formatTextParser )
+ TreeListBuilder( final FormatedTextParser formatTextParser )
throws IllegalArgumentException
{
if ( formatTextParser == null )
@@ -333,7 +304,7 @@
* @param level indentation level of the item
* @param text text of the item
*/
- public void feedEntry( final GenericListBlockParser.Type type,
+ void feedEntry( final GenericListBlockParser.Type type,
final int level, final String text )
{
final int currentDepth = current.getDepth();
@@ -381,7 +352,7 @@
/**
* @return a Block for the list that we received
*/
- public ListBlock getBlock()
+ ListBlock getBlock()
{
return getList( root );
}
@@ -409,7 +380,7 @@
for ( int i = 0; i < tc.getChildren().length; i++ )
{
final TreeComponent child = tc.getChildren()[i];
-
+
Block[] text = new Block[]{};
if ( child.getFather() != null )
{
@@ -428,12 +399,12 @@
return blocks;
}
-
+
/**
* A bidirectional tree node
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
class TreeComponent
{
@@ -461,7 +432,7 @@
* @param text component text
* @param type component type
*/
- public TreeComponent( final TreeComponent father, final String text,
+ TreeComponent( final TreeComponent father, final String text,
final GenericListBlockParser.Type type )
{
this.text = text;
@@ -472,7 +443,7 @@
/**
* @return my childrens
*/
- public TreeComponent[] getChildren()
+ TreeComponent[] getChildren()
{
return (TreeComponent[]) children.toArray( new TreeComponent[]{} );
}
@@ -484,7 +455,7 @@
* @param ttype component type
* @return the new node created
*/
- public TreeComponent addChildren( final String t,
+ TreeComponent addChildren( final String t,
final GenericListBlockParser.Type ttype )
{
if ( t == null || ttype == null )
@@ -500,7 +471,7 @@
/**
* @return the father
*/
- public TreeComponent getFather()
+ TreeComponent getFather()
{
return father;
}
@@ -508,7 +479,7 @@
/**
* @return the node depth in the tree
*/
- public int getDepth()
+ int getDepth()
{
int ret = 0;
@@ -522,18 +493,13 @@
return ret;
}
- /**
- * @see Object#toString()
- */
-
+ /** {@inheritDoc} */
public String toString()
{
return toString( "" );
}
- /**
- * @see Object#toString()
- */
+ /** {@inheritDoc} */
public String toString( final String indent )
{
final StringBuffer sb = new StringBuffer();
@@ -558,7 +524,7 @@
*
* @return <code>String</code> with the text.
*/
- public String getText()
+ String getText()
{
return text;
}
@@ -568,11 +534,9 @@
*
* @return <code>Type</code> with the text.
*/
- public GenericListBlockParser.Type getType()
+ GenericListBlockParser.Type getType()
{
return type;
}
}
-
}
-
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HRuleBlockParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HRuleBlockParser.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HRuleBlockParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HRuleBlockParser.java Fri Feb 29 16:29:17 2008
@@ -30,7 +30,7 @@
* Block that represents an horizontal rule
*
* @author Juan F. Codagnone
- * @since Nov 5, 2005
+ * @version $Id$
*/
public class HRuleBlockParser implements BlockParser
{
@@ -40,9 +40,7 @@
private static final Pattern HRULE_PATTERN =
Pattern.compile( "^(---)(-*)(.*)$" );
- /**
- * @see BlockParser#accept(String)
- */
+ /** {@inheritDoc} */
public final boolean accept( final String line )
{
final Matcher m = HRULE_PATTERN.matcher( line );
@@ -61,9 +59,7 @@
return ret;
}
- /**
- * @see BlockParser#visit(String, ByLineSource)
- */
+ /** {@inheritDoc} */
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HorizontalRuleBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HorizontalRuleBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HorizontalRuleBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HorizontalRuleBlock.java Fri Feb 29 16:29:17 2008
@@ -26,33 +26,24 @@
* Represents an horizontal block
*
* @author Juan F. Codagnone
- * @since Nov 5, 2005
+ * @version $Id$
*/
-public class HorizontalRuleBlock implements Block
+class HorizontalRuleBlock implements Block
{
-
- /**
- * @see Block#traverse(org.apache.maven.doxia.sink.Sink)
- */
+ /** {@inheritDoc} */
public final void traverse( final Sink sink )
{
sink.horizontalRule();
}
- /**
- * @see Object#equals(Object)
- */
-
+ /** {@inheritDoc} */
public final boolean equals( final Object obj )
{
return obj == this
|| ( obj != null && getClass().equals( obj.getClass() ) );
}
- /**
- * @see Object#hashCode()
- */
-
+ /** {@inheritDoc} */
public final int hashCode()
{
final int hashCode = 214905655;
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java Fri Feb 29 16:29:17 2008
@@ -21,14 +21,13 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Block that represents an image.
- *
+ *
* @author Christian Nardi
- * @since Nov 6, 2007
+ * @version $Id$
*/
-public class ImageBlock implements Block
+class ImageBlock implements Block
{
/**
* img reference
@@ -41,7 +40,7 @@
* @param imgReference img reference
* @throws IllegalArgumentException if the argument is <code>null</code>
*/
- public ImageBlock( final String imgReference )
+ ImageBlock( final String imgReference )
{
if ( imgReference == null )
{
@@ -50,10 +49,7 @@
this.reference = imgReference;
}
- /**
- * @see Block#traverse(org.apache.maven.doxia.sink.Sink)
- * @param sink the sink that travers
- */
+ /** {@inheritDoc} */
public final void traverse( final Sink sink )
{
sink.figure();
@@ -61,12 +57,7 @@
sink.figure_();
}
- /**
- * @see Object#equals(Object)
- * @param obj the reference object with which to compare.
- * @return <code>true</code> if this object is the same as the obj
- * argument; <code>false</code> otherwise.
- */
+ /** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
@@ -84,11 +75,7 @@
return ret;
}
- /**
- * @see Object#hashCode()
- * @return a hash code value for this object.
- */
-
+ /** {@inheritDoc} */
public final int hashCode()
{
final int magic1 = 17;
@@ -96,5 +83,4 @@
return magic1 + magic2 * reference.hashCode();
}
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ItalicBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ItalicBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ItalicBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ItalicBlock.java Fri Feb 29 16:29:17 2008
@@ -21,42 +21,33 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Block that represents the italic text format
*
* @author Juan F. Codagnone
- * @since Nov 2, 2005
+ * @version $Id$
*/
-public class ItalicBlock extends AbstractFatherBlock
+class ItalicBlock extends AbstractFatherBlock
{
-
/**
* Creates the BoldBlock.
*
* @param childBlocks child blocks
*/
- public ItalicBlock( final Block [] childBlocks )
+ ItalicBlock( final Block [] childBlocks )
{
super( childBlocks );
}
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.italic();
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.italic_();
}
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/LinkBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/LinkBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/LinkBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/LinkBlock.java Fri Feb 29 16:29:17 2008
@@ -21,14 +21,13 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Block that represents a link.
*
* @author Juan F. Codagnone
- * @since Nov 4, 2005
+ * @version $Id$
*/
-public class LinkBlock implements Block
+class LinkBlock implements Block
{
/**
* link reference
@@ -42,15 +41,15 @@
/**
* Creates the LinkBlock.
*
- * @param reference reference anchor
+ * @param reference reference anchor
* @param text text to display
* @deprecated
*/
- public LinkBlock( final String reference, final String text )
+ LinkBlock( final String reference, final String text )
{
this( reference, new TextBlock( text ) );
}
-
+
/**
* Creates the LinkBlock.
*
@@ -58,7 +57,7 @@
* @param content block with the displayed content
* @throws IllegalArgumentException if any argument is <code>null</code>
*/
- public LinkBlock( final String reference, final Block content )
+ LinkBlock( final String reference, final Block content )
throws IllegalArgumentException
{
if ( reference == null || content == null )
@@ -69,9 +68,7 @@
this.content = content;
}
- /**
- * @see Block#traverse(org.apache.maven.doxia.sink.Sink)
- */
+ /** {@inheritDoc} */
public final void traverse( final Sink sink )
{
sink.link( reference );
@@ -80,10 +77,7 @@
}
- /**
- * @see Object#equals(Object)
- */
-
+ /** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
@@ -102,10 +96,7 @@
return ret;
}
- /**
- * @see Object#hashCode()
- */
-
+ /** {@inheritDoc} */
public final int hashCode()
{
final int magic1 = 17;
@@ -114,5 +105,4 @@
return magic1 + magic2 * reference.hashCode()
+ magic2 * content.hashCode();
}
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListBlock.java Fri Feb 29 16:29:17 2008
@@ -29,9 +29,9 @@
* </pre>
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
-public abstract class ListBlock extends AbstractFatherBlock
+abstract class ListBlock extends AbstractFatherBlock
{
/**
* Creates the ListBlock.
@@ -39,10 +39,9 @@
* @param blocks list of list items
* @throws IllegalArgumentException if listItemBlocks is <code>null</code>
*/
- public ListBlock( final ListItemBlock[] blocks )
+ ListBlock( final ListItemBlock[] blocks )
throws IllegalArgumentException
{
super( blocks );
}
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListItemBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListItemBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListItemBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListItemBlock.java Fri Feb 29 16:29:17 2008
@@ -21,22 +21,20 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Block that represents the item in a list
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
-public class ListItemBlock extends AbstractFatherBlock
+class ListItemBlock extends AbstractFatherBlock
{
- /** */
private final ListBlock innerList;
/**
* @see #ListItemBlock(Block[], ListBlock)
*/
- public ListItemBlock( final Block [] blocks )
+ ListItemBlock( final Block [] blocks )
throws IllegalArgumentException
{
this( blocks, null );
@@ -49,27 +47,21 @@
* @param innerList child list
* @throws IllegalArgumentException if textBlocks is null
*/
- public ListItemBlock( final Block [] blocks, final ListBlock innerList )
+ ListItemBlock( final Block [] blocks, final ListBlock innerList )
throws IllegalArgumentException
{
super( blocks );
this.innerList = innerList;
}
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.listItem();
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
if ( innerList != null )
{
@@ -83,15 +75,12 @@
*
* @return <code>UnorderedListBlock</code> with the innerList.
*/
- public final ListBlock getInnerList()
+ final ListBlock getInnerList()
{
return innerList;
}
- /**
- * @see Object#equals(Object)
- */
-
+ /** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
@@ -124,10 +113,7 @@
return ret;
}
- /**
- * @see Object#hashCode()
- */
-
+ /** {@inheritDoc} */
public final int hashCode()
{
final int magic1 = 17;
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/MonospaceBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/MonospaceBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/MonospaceBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/MonospaceBlock.java Fri Feb 29 16:29:17 2008
@@ -21,42 +21,33 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Block that represents the monospaced text format
*
* @author Juan F. Codagnone
- * @since Nov 2, 2005
+ * @version $Id$
*/
-public class MonospaceBlock extends AbstractFatherBlock
+class MonospaceBlock extends AbstractFatherBlock
{
-
/**
* Creates the MonospaceBlock.
*
* @param childBlocks child blocks
*/
- public MonospaceBlock( final Block [] childBlocks )
+ MonospaceBlock( final Block [] childBlocks )
{
super( childBlocks );
}
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.monospaced();
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.monospaced_();
}
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NopBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NopBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NopBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NopBlock.java Fri Feb 29 16:29:17 2008
@@ -21,37 +21,27 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Block that not represent anything
*
* @author Juan F. Codagnone
- * @since Nov 6, 2005
+ * @version $Id$
*/
-public class NopBlock implements Block
+class NopBlock implements Block
{
-
- /**
- * @see Block#traverse(org.apache.maven.doxia.sink.Sink)
- */
+ /** {@inheritDoc} */
public final void traverse( final Sink sink )
{
// nothing to do!!
}
- /**
- * @see Object#equals(Object)
- */
-
+ /** {@inheritDoc} */
public final boolean equals( final Object obj )
{
return this == obj && getClass().equals( obj.getClass() );
}
- /**
- * @see Object#hashCode()
- */
-
+ /** {@inheritDoc} */
public final int hashCode()
{
final int magic = 518409602;
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NumeratedListBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NumeratedListBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NumeratedListBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NumeratedListBlock.java Fri Feb 29 16:29:17 2008
@@ -21,7 +21,6 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* <pre>
* 1. item1
@@ -31,9 +30,9 @@
* </pre>
*
* @author Juan F. Codagnone
- * @since Nov 8, 2005
+ * @version $Id$
*/
-public class NumeratedListBlock extends ListBlock
+class NumeratedListBlock extends ListBlock
{
/**
* order item type. one of Sink#NUMBERING_....
@@ -47,36 +46,26 @@
* @param blocks list of list items
* @throws IllegalArgumentException if listItemBlocks is <code>null</code>
*/
- public NumeratedListBlock( final int type, final ListItemBlock[] blocks )
+ NumeratedListBlock( final int type, final ListItemBlock[] blocks )
throws IllegalArgumentException
{
super( blocks );
this.type = type;
}
-
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.numberedList( type );
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.numberedList_();
}
- /**
- * @see AbstractFatherBlock#equals(Object)
- */
-
+ /** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
@@ -89,10 +78,7 @@
return ret;
}
- /**
- * @see AbstractFatherBlock#hashCode()
- */
-
+ /** {@inheritDoc} */
public final int hashCode()
{
final int magic = 17;
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlock.java Fri Feb 29 16:29:17 2008
@@ -21,26 +21,26 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
-public class ParagraphBlock extends AbstractFatherBlock
+class ParagraphBlock extends AbstractFatherBlock
{
- public ParagraphBlock( final Block []blocks )
+ ParagraphBlock( final Block []blocks )
throws IllegalArgumentException
{
super( blocks );
}
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.paragraph();
}
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.paragraph_();
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlockParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlockParser.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlockParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlockParser.java Fri Feb 29 16:29:17 2008
@@ -28,12 +28,11 @@
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
-
/**
* Parse paragraphs.
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
public class ParagraphBlockParser implements BlockParser
{
@@ -61,8 +60,8 @@
* {@link TableBlockParser} to use. injected
*/
private TableBlockParser tableBlockParser;
-
- /**
+
+ /**
* {@link TableBlockParser} to use. injected
*/
private VerbatimBlockParser verbatimParser;
@@ -72,25 +71,15 @@
*/
private static final NopBlock NOP = new NopBlock();
- /**
- * @see BlockParser#accept(String)
- * @param line text line
- * @return <code>true</code> if this class can handle this line
- */
+ /** {@inheritDoc} */
public final boolean accept( final String line )
{
- return !sectionParser.accept( line )
+ return !sectionParser.accept( line )
&& !hrulerParser.accept( line )
&& !verbatimParser.accept( line );
}
- /**
- * @see BlockParser#visit(String, ByLineSource)
- * @param line a line of text
- * @param source the source of lines
- * @return a block
- * @throws ParseException on error
- */
+ /** {@inheritDoc} */
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
@@ -160,12 +149,9 @@
{
return NOP;
}
- else
- {
- return new ParagraphBlock( (Block[]) childs.toArray( new Block[]{} ) );
- }
- }
+ return new ParagraphBlock( (Block[]) childs.toArray( new Block[]{} ) );
+ }
/**
* Sets the sectionParser.
@@ -181,7 +167,6 @@
this.sectionParser = aSectionParser;
}
-
/**
* Sets the listParser.
*
@@ -197,7 +182,6 @@
this.listParser = aListParser;
}
-
/**
* Sets the formatTextParser.
*
@@ -213,7 +197,6 @@
this.textParser = aTextParser;
}
-
/**
* Sets the hrulerParser.
*
@@ -244,11 +227,11 @@
}
/**
- * Sets the verbatimParser.
+ * Sets the verbatimParser.
*
* @param aVerbatimParser <code>VerbatimBlockParser</code> with the verbatimParser.
*/
- public final void setVerbatimParser( final VerbatimBlockParser aVerbatimParser )
+ public final void setVerbatimParser( final VerbatimBlockParser aVerbatimParser )
{
if ( aVerbatimParser == null )
{
@@ -256,6 +239,4 @@
}
this.verbatimParser = aVerbatimParser;
}
-
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlock.java Fri Feb 29 16:29:17 2008
@@ -24,22 +24,18 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Block that represents a section
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
public class SectionBlock extends AbstractFatherBlock
{
- /**
- * @see #SectionBlock(String, int, Block[])
- */
+ /** {@inheritDoc} */
private final String title;
- /**
- * @see #SectionBlock(String, int, Block[])
- */
+
+ /** {@inheritDoc} */
private final int level;
/**
@@ -70,11 +66,8 @@
this.level = level;
}
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sectionStart( sink );
sectionTitle( sink );
@@ -83,14 +76,10 @@
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sectionEnd( sink );
-
}
/**
@@ -113,7 +102,6 @@
invokeVoidVoid( sink, "section" + level + "_" );
}
-
/**
* Let you call sink's methods that returns <code>null</code> and have
* no parameters.
@@ -158,10 +146,7 @@
return title;
}
- /**
- * @see Object#toString()
- */
-
+ /** {@inheritDoc} */
public final String toString()
{
final StringBuffer sb = new StringBuffer();
@@ -183,13 +168,13 @@
}
/** @param sink */
- private void sectionTitle( final Sink sink )
+ private void sectionTitle( final Sink sink )
{
invokeVoidVoid( sink, "sectionTitle" + level );
}
-
+
/** @param sink */
- private void sectionTitle_( final Sink sink )
+ private void sectionTitle_( final Sink sink )
{
invokeVoidVoid( sink, "sectionTitle" + level + "_" );
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlockParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlockParser.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlockParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlockParser.java Fri Feb 29 16:29:17 2008
@@ -26,12 +26,11 @@
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
-
/**
* Parse looking for sections
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
public class SectionBlockParser implements BlockParser
{
@@ -45,26 +44,22 @@
* {@link ParagraphBlockParser} to use. injected
*/
private ParagraphBlockParser paraParser;
+
/**
* {@link ParagraphBlockParser} to use. injected
*/
private HRuleBlockParser hrulerParser;
-
+
/** {@link VerbatimBlockParser} */
private VerbatimBlockParser verbatimBlockParser;
- /**
- * @see BlockParser#accept(String)
- */
+ /** {@inheritDoc} */
public final boolean accept( final String s )
{
-
return HEADER_DA.matcher( s ).lookingAt();
}
- /**
- * @see BlockParser#visit(String)
- */
+ /** {@inheritDoc} */
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
@@ -136,7 +131,6 @@
this.paraParser = paraParser;
}
-
/**
* Sets the hrulerParser.
*
@@ -152,7 +146,7 @@
}
/**
- * Sets the verbatimBlockParser.
+ * Sets the verbatimBlockParser.
*
* @param verbatimBlockParser <code>VerbatimBlockParser</code> with the verbatimBlockParser.
*/
@@ -163,5 +157,4 @@
}
this.verbatimBlockParser = verbatimBlockParser;
}
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlock.java Fri Feb 29 16:29:17 2008
@@ -22,16 +22,14 @@
import org.apache.maven.doxia.parser.Parser;
import org.apache.maven.doxia.sink.Sink;
-
/**
* Represents a table
*
* @author Juan F. Codagnone
- * @since Nov 10, 2005
+ * @version $Id$
*/
public class TableBlock extends AbstractFatherBlock
{
-
/**
* Creates the TableBlock.
*
@@ -42,28 +40,20 @@
super( childBlocks );
}
-
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.table();
sink.tableRows( getJustification(), false );
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.tableRows_();
sink.table_();
}
-
-
+
private final int [] getJustification() {
int[] justification = new int[((AbstractFatherBlock)getBlocks()[0]).
getBlocks().length];
@@ -71,7 +61,7 @@
{
justification[i] = Parser.JUSTIFY_CENTER;
}
-
+
return justification;
}
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlockParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlockParser.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlockParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlockParser.java Fri Feb 29 16:29:17 2008
@@ -27,12 +27,11 @@
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
-
/**
* Parse tables
*
* @author Juan F. Codagnone
- * @since Nov 9, 2005
+ * @version $Id$
*/
public class TableBlockParser implements BlockParser
{
@@ -46,21 +45,16 @@
*/
private FormatedTextParser textParser;
- /**
- * @see BlockParser#accept(String)
- */
+ /** {@inheritDoc} */
public final boolean accept( final String line )
{
return TABLE_PATTERN.matcher( line ).lookingAt();
}
- /**
- * @see BlockParser#visit(String, ByLineSource)
- */
+ /** {@inheritDoc} */
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
-
if ( !accept( line ) )
{
throw new IllegalAccessError( "call accept before this ;)" );
@@ -104,7 +98,6 @@
return new TableBlock( (Block[]) rows.toArray( new Block[]{} ) );
}
-
/**
* @param textParser text parser to be set
*/
@@ -117,5 +110,4 @@
this.textParser = textParser;
}
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellBlock.java Fri Feb 29 16:29:17 2008
@@ -26,35 +26,28 @@
* Table cell
*
* @author Juan F. Codagnone
- * @since Nov 10, 2005
+ * @version $Id$
*/
public class TableCellBlock extends AbstractFatherBlock
{
-
/**
* Creates the TableCellBlock.
*
* @param childBlocks childrens
*/
- public TableCellBlock( final Block [] childBlocks )
+ TableCellBlock( final Block [] childBlocks )
{
super( childBlocks );
}
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.tableCell();
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.tableCell_();
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellHeaderBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellHeaderBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellHeaderBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellHeaderBlock.java Fri Feb 29 16:29:17 2008
@@ -21,40 +21,32 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Table Cell headear
*
* @author Juan F. Codagnone
- * @since Nov 10, 2005
+ * @version $Id$
*/
-public class TableCellHeaderBlock extends AbstractFatherBlock
+class TableCellHeaderBlock extends AbstractFatherBlock
{
-
/**
* Creates the TableCellHeaderBlock.
*
* @param childBlocks childrens
*/
- public TableCellHeaderBlock( final Block [] childBlocks )
+ TableCellHeaderBlock( final Block [] childBlocks )
{
super( childBlocks );
}
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.tableHeaderCell();
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.tableHeaderCell_();
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableRowBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableRowBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableRowBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableRowBlock.java Fri Feb 29 16:29:17 2008
@@ -26,37 +26,29 @@
* Represens a Table Row
*
* @author Juan F. Codagnone
- * @since Nov 10, 2005
+ * @version $Id$
*/
-public class TableRowBlock extends AbstractFatherBlock
+class TableRowBlock extends AbstractFatherBlock
{
-
/**
* Creates the TableRowBlock.
*
* @param childBlocks children blocks
*/
- public TableRowBlock( final Block [] childBlocks )
+ TableRowBlock( final Block [] childBlocks )
{
super( childBlocks );
}
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.tableRow();
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.tableRow_();
}
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextBlock.java Fri Feb 29 16:29:17 2008
@@ -21,14 +21,13 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Block that holds plain text
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
-public class TextBlock implements Block
+class TextBlock implements Block
{
/**
* the text
@@ -41,7 +40,7 @@
* @param text some text. can't ben <code>null</code>
* @throws IllegalArgumentException if parameters are not in the domain
*/
- public TextBlock( final String text ) throws IllegalArgumentException
+ TextBlock( final String text ) throws IllegalArgumentException
{
if ( text == null )
{
@@ -51,38 +50,29 @@
this.text = text;
}
- /**
- * @see Block#traverse(org.apache.maven.doxia.sink.Sink)
- */
+ /** {@inheritDoc} */
public final void traverse( final Sink sink )
{
sink.text( text );
}
- /**
- * @see Object#toString()
- */
-
+ /** {@inheritDoc} */
public final String toString()
{
return getClass().getName() + ": [" + text.replaceAll( "\n", "\\n" ) + "]";
}
-
/**
* Returns the text.
*
* @return <code>String</code> with the text.
*/
- public final String getText()
+ final String getText()
{
return text;
}
- /**
- * @see Object#equals(Object)
- */
-
+ /** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
@@ -100,10 +90,7 @@
return ret;
}
- /**
- * @see Object#hashCode()
- */
-
+ /** {@inheritDoc} */
public final int hashCode()
{
return text.hashCode();
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java Fri Feb 29 16:29:17 2008
@@ -25,12 +25,11 @@
import java.util.regex.Matcher;
import java.util.regex.Pattern;
-
/**
* Parse almost plain text in search of WikiWords, links, ...
*
* @author Juan F. Codagnone
- * @since Nov 4, 2005
+ * @version $Id$
*/
public class TextParser
{
@@ -59,13 +58,13 @@
*/
private static final Pattern URL_PATTERN =
Pattern.compile( "(\\w+):[/][/][^\\s]*" );
-
+
/**
* image pattern specification
*/
- private static final Pattern IMAGE_PATTERN =
+ private static final Pattern IMAGE_PATTERN =
Pattern.compile( "(.*)\\.(png|jpg|gif|bmp)" );
-
+
/**
* image tag pattern specification (used for images at relative URLs)
*/
@@ -81,10 +80,11 @@
* Creates the TextParser.
* @param resolver resolver for wikiWord links
*/
- public TextParser( final WikiWordLinkResolver resolver )
+ public TextParser( final WikiWordLinkResolver resolver )
{
this.wikiWordLinkResolver = resolver;
}
+
/**
* @param line line to parse
* @return a list of block that represents the input
@@ -158,16 +158,16 @@
{
ret.addAll( parse( line.substring( 0, urlMatcher.start() ) ) );
final String url = urlMatcher.group( 0 );
- final Matcher imageMatcher = IMAGE_PATTERN.matcher( url );
- if ( imageMatcher.matches() )
+ final Matcher imageMatcher = IMAGE_PATTERN.matcher( url );
+ if ( imageMatcher.matches() )
{
ret.add( new ImageBlock( url ) );
- }
- else
+ }
+ else
{
ret.add( new LinkBlock( url, url ) );
}
- ret.addAll( parse( line.substring(
+ ret.addAll( parse( line.substring(
urlMatcher.end(), line.length() ) ) );
}
@@ -189,7 +189,7 @@
* Parses the link
* @param line line to parse
* @param ret where the results live
- * @param forcedLinkMatcher forced link matcher
+ * @param forcedLinkMatcher forced link matcher
*/
private void parseForcedLink( final String line, final List ret,
final Matcher forcedLinkMatcher )
@@ -218,10 +218,10 @@
}
else
{
- ret.addAll( parse( line.substring( 0,
+ ret.addAll( parse( line.substring( 0,
forcedLinkMatcher.start() ) ) );
ret.add( createLink( showText, showText ) );
- ret.addAll( parse( line.substring( forcedLinkMatcher.end(),
+ ret.addAll( parse( line.substring( forcedLinkMatcher.end(),
line.length() ) ) );
}
}
@@ -233,36 +233,34 @@
* @param showText the show text.
* @return either a WikiWordBlock or a LinkBlock
*/
- private Block createLink( final String link, final String showText )
+ private Block createLink( final String link, final String showText )
{
final Block content;
- if( URL_PATTERN.matcher( showText ).matches() && IMAGE_PATTERN.matcher( showText ).matches() )
+ if( URL_PATTERN.matcher( showText ).matches() && IMAGE_PATTERN.matcher( showText ).matches() )
{
content = new ImageBlock( showText );
}
- else
+ else
{
content = new TextBlock( showText );
}
-
- if ( URL_PATTERN.matcher( link ).matches() )
+
+ if ( URL_PATTERN.matcher( link ).matches() )
{
return new LinkBlock( link, content );
}
- else
- {
- final StringTokenizer tokenizer =
- new StringTokenizer( link );
- final StringBuffer sb = new StringBuffer();
- while ( tokenizer.hasMoreElements() )
- {
- final String s = tokenizer.nextToken();
- sb.append( s.substring( 0, 1 ).toUpperCase() );
- sb.append( s.substring( 1 ) );
- }
- return new WikiWordBlock( sb.toString(), content, wikiWordLinkResolver );
+ final StringTokenizer tokenizer =
+ new StringTokenizer( link );
+ final StringBuffer sb = new StringBuffer();
+
+ while ( tokenizer.hasMoreElements() )
+ {
+ final String s = tokenizer.nextToken();
+ sb.append( s.substring( 0, 1 ).toUpperCase() );
+ sb.append( s.substring( 1 ) );
}
+ return new WikiWordBlock( sb.toString(), content, wikiWordLinkResolver );
}
@@ -347,7 +345,7 @@
return ret;
}
-
+
/**
* @param m matcher to test
* @param line line to test
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/UnorderedListBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/UnorderedListBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/UnorderedListBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/UnorderedListBlock.java Fri Feb 29 16:29:17 2008
@@ -21,7 +21,6 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* <pre>
* - item1
@@ -31,9 +30,9 @@
* </pre>
*
* @author Juan F. Codagnone
- * @since Nov 1, 2005
+ * @version $Id$
*/
-public class UnorderedListBlock extends ListBlock
+class UnorderedListBlock extends ListBlock
{
/**
* Creates the UnorderedListBlock.
@@ -41,29 +40,21 @@
* @param blocks list of list items
* @throws IllegalArgumentException if listItemBlocks is <code>null</code>
*/
- public UnorderedListBlock( final ListItemBlock[] blocks )
+ UnorderedListBlock( final ListItemBlock[] blocks )
throws IllegalArgumentException
{
super( blocks );
}
-
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.list();
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.list_();
}
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlock.java Fri Feb 29 16:29:17 2008
@@ -21,43 +21,32 @@
import org.apache.maven.doxia.sink.Sink;
-
/**
* Represents a verbatim block
- *
+ *
* @author Christian Nardi
- * @since Nov 8, 2007
+ * @version $Id$
*/
-public class VerbatimBlock extends AbstractFatherBlock
+class VerbatimBlock extends AbstractFatherBlock
{
-
/**
* Creates the VerbatimBlock.
*
* @param childBlocks child blocks
*/
- public VerbatimBlock( final Block [] childBlocks )
+ VerbatimBlock( final Block [] childBlocks )
{
super( childBlocks );
}
-
- /**
- * @see AbstractFatherBlock#before(org.apache.maven.doxia.sink.Sink)
- * @param sink a sink to fill
- */
-
- public final void before( final Sink sink )
+ /** {@inheritDoc} */
+ final void before( final Sink sink )
{
sink.verbatim( true );
}
- /**
- * @see AbstractFatherBlock#after(org.apache.maven.doxia.sink.Sink)
- * @param sink a sink to fill
- */
-
- public final void after( final Sink sink )
+ /** {@inheritDoc} */
+ final void after( final Sink sink )
{
sink.verbatim_();
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlockParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlockParser.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlockParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlockParser.java Fri Feb 29 16:29:17 2008
@@ -27,12 +27,11 @@
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.util.ByLineSource;
-
/**
* Parse verbatim blocks
- *
+ *
* @author Christian Nardi
- * @since Nov 8, 2007
+ * @version $Id$
*/
public class VerbatimBlockParser implements BlockParser
{
@@ -41,31 +40,20 @@
*/
private static final Pattern VERBATIM_START_PATTERN =
Pattern.compile( "\\s*<verbatim>" );
-
+
private static final Pattern VERBATIM_END_PATTERN =
Pattern.compile( "</verbatim>" );
- /**
- * @see BlockParser#accept(String)
- * @param line text line
- * @return <code>true</code> if this class can handle this line
- */
+ /** {@inheritDoc} */
public final boolean accept( final String line )
{
return VERBATIM_START_PATTERN.matcher( line ).lookingAt();
}
- /**
- * @see BlockParser#visit(String, ByLineSource)
- * @param line a line of text
- * @param source the source of lines
- * @return a block
- * @throws ParseException on error
- */
+ /** {@inheritDoc} */
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
-
if ( !accept( line ) )
{
throw new IllegalAccessError( "call accept before this ;)" );
@@ -79,7 +67,7 @@
while ( l != null )
{
matcher = VERBATIM_END_PATTERN.matcher( l );
- if ( matcher.find() )
+ if ( matcher.find() )
{
lines.add( new TextBlock( l.substring( 0, matcher.start() ) + "\n" ) );
break;
@@ -87,7 +75,7 @@
lines.add( new TextBlock( l + "\n" ) );
l = source.getNextLine();
}
-
+
return new VerbatimBlock( (Block[]) lines.toArray( new Block[]{} ) );
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordBlock.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordBlock.java Fri Feb 29 16:29:17 2008
@@ -26,9 +26,9 @@
* Represent a WikiWord
*
* @author Juan F. Codagnone
- * @since Nov 4, 2005
+ * @version $Id$
*/
-public class WikiWordBlock implements Block
+class WikiWordBlock implements Block
{
/**
* the wiki word
@@ -43,14 +43,12 @@
*/
private final WikiWordLinkResolver wikiWordLinkResolver;
-
-
/**
* @see #WikiWordBlock(String, String)
* @param aWikiword the wikiWord
* @param resolver responsible of resolving the link to the wikiWord
*/
- public WikiWordBlock( final String aWikiword,
+ WikiWordBlock( final String aWikiword,
final WikiWordLinkResolver resolver )
{
this( aWikiword, aWikiword, resolver );
@@ -61,25 +59,25 @@
*
* @param aWikiword the wiki word
* @param aText text to show in the wiki link
- * @param resolver responsible of resolving the link to the wikiWord
+ * @param resolver responsible of resolving the link to the wikiWord
* @throws IllegalArgumentException if the wikiword is <code>null</code>
* @deprecated
*/
- public WikiWordBlock( final String aWikiword, final String aText ,
+ WikiWordBlock( final String aWikiword, final String aText ,
final WikiWordLinkResolver resolver )
{
this( aWikiword, new TextBlock( aText ), resolver );
}
-
+
/**
* Creates the WikiWordBlock.
*
* @param aWikiword the wiki word
* @param aText text to show in the wiki link
- * @param resolver responsible of resolving the link to the wikiWord
+ * @param resolver responsible of resolving the link to the wikiWord
* @throws IllegalArgumentException if the wikiword is <code>null</code>
*/
- public WikiWordBlock( final String aWikiword, final Block content ,
+ WikiWordBlock( final String aWikiword, final Block content ,
final WikiWordLinkResolver resolver )
{
if ( aWikiword == null || content == null || resolver == null )
@@ -91,10 +89,7 @@
this.wikiWordLinkResolver = resolver;
}
- /**
- * @see Block#traverse(org.apache.maven.doxia.sink.Sink)
- * @param sink the sink that travers
- */
+ /** {@inheritDoc} */
public final void traverse( final Sink sink )
{
sink.link( wikiWordLinkResolver.resolveLink( wikiword ) );
@@ -102,13 +97,7 @@
sink.link_();
}
- /**
- * @see Object#equals(Object)
- * @param obj the reference object with which to compare.
- * @return <code>true</code> if this object is the same as the obj
- * argument; <code>false</code> otherwise.
- */
-
+ /** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
@@ -127,11 +116,7 @@
return ret;
}
- /**
- * @see Object#hashCode()
- * @return a hash code value for this object.
- */
-
+ /** {@inheritDoc} */
public final int hashCode()
{
final int magic1 = 17;
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordLinkResolver.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordLinkResolver.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordLinkResolver.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordLinkResolver.java Fri Feb 29 16:29:17 2008
@@ -19,23 +19,19 @@
* under the License.
*/
-
-
/**
* Resolves the WikiWordLinks
*
* @author Christian D. Nardi
- * @since Nov 7, 2007
+ * @version $Id$
*/
-public interface WikiWordLinkResolver
+interface WikiWordLinkResolver
{
-
/**
* Given a wikiWord, it returns a link string.
- *
+ *
* @param wikiWord wikiWord to resolve
* @return the link representation of the wikiWord.
*/
String resolveLink( final String wikiWord );
-
}
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/XHTMLWikiWordLinkResolver.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/XHTMLWikiWordLinkResolver.java?rev=632507&r1=632506&r2=632507&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/XHTMLWikiWordLinkResolver.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/XHTMLWikiWordLinkResolver.java Fri Feb 29 16:29:17 2008
@@ -20,23 +20,21 @@
/**
* Transform WikiWord to HTML links
- *
+ *
* @author Christian Nardi
- * @since Nov 7, 2007
+ * @version $Id$
*/
-public class XHTMLWikiWordLinkResolver implements WikiWordLinkResolver
+public class XHTMLWikiWordLinkResolver implements WikiWordLinkResolver
{
-
- /** @see org.apache.maven.doxia.module.twiki.parser.WikiWordLinkResolver#
- * resolveLink(java.lang.String)
- * This only works for xhtml output, but there is no way
+ /**
+ * This only works for xhtml output, but there is no way
* of transforming a wikiWord in another context.
* @param wikiWord wikiWord to resolve
* @return the link representation of the wikiWord.
+ * @see org.apache.maven.doxia.module.twiki.parser.WikiWordLinkResolver#resolveLink(java.lang.String)
*/
- public final String resolveLink( final String wikiWord )
+ public final String resolveLink( final String wikiWord )
{
return "./" + wikiWord + ".html";
}
-
}