View Javadoc

1   package org.apache.maven.doxia.module.twiki.parser;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.doxia.sink.Sink;
23  
24  /**
25   * <pre>
26   *    1. item1
27   *    2. item2
28   *        - item2.1
29   *        ...
30   * </pre>
31   *
32   * @author Juan F. Codagnone
33   * @version $Id: NumeratedListBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
34   */
35  class NumeratedListBlock
36      extends ListBlock
37  {
38      /**
39       * order item type. one of Sink#NUMBERING_....
40       */
41      private final int type;
42  
43      /**
44       * Creates the UnorderedListBlock.
45       *
46       * @param type   order item type. one of Sink#NUMBERING_....
47       * @param blocks list of list items, not null.
48       */
49      NumeratedListBlock( final int type, final ListItemBlock[] blocks )
50      {
51          super( blocks );
52          this.type = type;
53      }
54  
55      /** {@inheritDoc} */
56      final void before( final Sink sink )
57      {
58          sink.numberedList( type );
59      }
60  
61      /** {@inheritDoc} */
62      final void after( final Sink sink )
63      {
64          sink.numberedList_();
65      }
66  
67      /** {@inheritDoc} */
68      public final boolean equals( final Object obj )
69      {
70          boolean ret = false;
71  
72          if ( super.equals( obj ) )
73          {
74              ret = type == ( (NumeratedListBlock) obj ).type;
75          }
76  
77          return ret;
78      }
79  
80      /** {@inheritDoc} */
81      public final int hashCode()
82      {
83          final int magic = 17;
84          return super.hashCode() + magic * type;
85      }
86  }