Class CompletionXMLParser

java.lang.Object
org.xml.sax.helpers.DefaultHandler
org.fife.ui.autocomplete.CompletionXMLParser
All Implemented Interfaces:
ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class CompletionXMLParser extends DefaultHandler
Parser for an XML file describing a procedural language such as C. XML files will be validated against the CompletionXml.dtd DTD found in this package.
Version:
1.0
  • Field Details

    • completions

      private List<Completion> completions
      The completions found after parsing the XML.
    • provider

      private CompletionProvider provider
      The provider we're getting completions for.
    • completionCL

      private ClassLoader completionCL
      The completion provider to use when loading classes, such as custom FunctionCompletions.
    • name

      private String name
    • type

      private String type
    • returnType

      private String returnType
    • returnValDesc

      private StringBuilder returnValDesc
    • desc

      private StringBuilder desc
    • paramName

      private String paramName
    • paramType

      private String paramType
    • endParam

      private boolean endParam
    • paramDesc

      private StringBuilder paramDesc
    • params

    • definedIn

      private String definedIn
    • doingKeywords

      private boolean doingKeywords
    • inKeyword

      private boolean inKeyword
    • gettingReturnValDesc

      private boolean gettingReturnValDesc
    • gettingDesc

      private boolean gettingDesc
    • gettingParams

      private boolean gettingParams
    • inParam

      private boolean inParam
    • gettingParamDesc

      private boolean gettingParamDesc
    • inCompletionTypes

      private boolean inCompletionTypes
    • paramStartChar

      private char paramStartChar
    • paramEndChar

      private char paramEndChar
    • paramSeparator

      private String paramSeparator
    • funcCompletionType

      private String funcCompletionType
      If specified in the XML, this class will be used instead of FunctionCompletion when appropriate. This class should extend FunctionCompletion, or stuff will break.
    • defaultCompletionClassLoader

      private static ClassLoader defaultCompletionClassLoader
      The class loader to use to load custom completion classes, such as the one defined by funcCompletionType. If this is null, then a default class loader is used. This field will usually be null.
  • Constructor Details

    • CompletionXMLParser

      public CompletionXMLParser(CompletionProvider provider)
      Constructor.
      Parameters:
      provider - The provider to get completions for.
      See Also:
    • CompletionXMLParser

      public CompletionXMLParser(CompletionProvider provider, ClassLoader cl)
      Constructor.
      Parameters:
      provider - The provider to get completions for.
      cl - The class loader to use, if necessary, when loading classes from the XML (custom FunctionCompletions, for example). This may be null if the default is to be used, or if the XML does not define specific classes for completion types.
      See Also:
  • Method Details