Class SectionBlock

  • All Implemented Interfaces:
    Block

    public class SectionBlock
    extends java.lang.Object
    Block that represents a section
    Author:
    Juan F. Codagnone
    • Constructor Summary

      Constructors 
      Constructor Description
      SectionBlock​(java.lang.String title, int level, Block[] blocks)
      Creates the SectionBlock.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Block[] getBlocks()
      Returns the childBlocks.
      int getLevel()
      Returns the level.
      java.lang.String getTitle()
      Returns the title.
      int hashCode()
      java.lang.String toString()
      void traverse​(org.apache.maven.doxia.sink.Sink sink)
      Traverse the block
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • SectionBlock

        public SectionBlock​(java.lang.String title,
                            int level,
                            Block[] blocks)
        Creates the SectionBlock.
        Parameters:
        title - the section title, cannot be null
        level - the section level: 0 < level < 6
        blocks - child blocks, cannot be null
    • Method Detail

      • getLevel

        public final int getLevel()
        Returns the level.
        Returns:
        int with the level.
      • getTitle

        public final java.lang.String getTitle()
        Returns the title.
        Returns:
        String with the title.
      • toString

        public final java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Returns:
        a String object.
      • traverse

        public final void traverse​(org.apache.maven.doxia.sink.Sink sink)
        Traverse the block
        Specified by:
        traverse in interface Block
        Parameters:
        sink - the sink that travers
      • getBlocks

        public final Block[] getBlocks()
        Returns the childBlocks.
        Returns:
        Block[] with the childBlocks.
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a int.