Interface ISection

  • All Known Subinterfaces:
    IUserDefined
    All Known Implementing Classes:
    SectionHandler

    public interface ISection
    The public interface to a section in the object model. A compound can have a number of sections, where each section contains a set of members with the properties implied by the section kind. The kind() method returns the kind of the section. The members of the section can be accessed via members(). Apart from using kind(), some of the individual properties of the section can also be inspected via isStatic(), isPublic(), isProtected() and isPrivate().
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  ISection.SectionKind
      Possible section types
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      IDocRoot description()
      Returns the description attached to this section (for user defined sections, also known as member groups).
      boolean isPrivate()
      Returns \c true if this section belongs to a private section of a class
      boolean isProtected()
      Returns \c true if this section belongs to a protected section of a class
      boolean isPublic()
      Returns \c true if this section belongs to a public section of a class
      boolean isStatic()
      Returns \c true if this section contains statics
      ISection.SectionKind kind()
      Returns what kind of section this is
      java.lang.String kindString()
      Returns a string representation of the value returned by kind()
      java.util.ListIterator<IMember> members()
      Returns an iterator for the members of this section
    • Method Detail

      • kindString

        java.lang.String kindString()
        Returns a string representation of the value returned by kind()
      • description

        IDocRoot description()
        Returns the description attached to this section (for user defined sections, also known as member groups).
      • members

        java.util.ListIterator<IMember> members()
        Returns an iterator for the members of this section
      • isStatic

        boolean isStatic()
        Returns \c true if this section contains statics
      • isPublic

        boolean isPublic()
        Returns \c true if this section belongs to a public section of a class
      • isPrivate

        boolean isPrivate()
        Returns \c true if this section belongs to a private section of a class
      • isProtected

        boolean isProtected()
        Returns \c true if this section belongs to a protected section of a class