Class SnapshotQueryContext

    • Constructor Detail

      • SnapshotQueryContext

        public SnapshotQueryContext​(ISnapshot snapshot)
    • Method Detail

      • getPrimaryFile

        public File getPrimaryFile()
        Description copied from interface: IQueryContext
        The main file for the snapshot
        Returns:
        the dump
      • getPrefix

        public String getPrefix()
        Description copied from interface: IQueryContext
        The prefix for files generated from snapshot
        Returns:
        the prefix
      • available

        public boolean available​(Class<?> type,
                                 Argument.Advice advice)
        Description copied from interface: IQueryContext
        Is this type of data available from the context?
        Specified by:
        available in interface IQueryContext
        Overrides:
        available in class QueryContextImpl
        Parameters:
        type - the type the data should be converted to
        advice - advice such as from the query as to how the value should be converted.
        Returns:
        true if available.
      • get

        public Object get​(Class<?> type,
                          Argument.Advice advice)
        Description copied from interface: IQueryContext
        Get this type of data from the context.
        Specified by:
        get in interface IQueryContext
        Overrides:
        get in class QueryContextImpl
        Parameters:
        type - the type the data should be converted to
        advice - advice such as from the query as to how the value should be converted.
        Returns:
        the object of the right type
      • converts

        public boolean converts​(Class<?> type,
                                Argument.Advice advice)
        Description copied from interface: IQueryContext
        Does the context have a converter for data of this type?
        Specified by:
        converts in interface IQueryContext
        Overrides:
        converts in class QueryContextImpl
        Parameters:
        type - The Java type of an argument to be supplied with data from this context.
        advice - Further details about the argument to be supplied with data.
        Returns:
        true if available and convertible
      • convertToString

        public String convertToString​(Class<?> type,
                                      Argument.Advice advice,
                                      Object value)
                               throws SnapshotException
        Description copied from interface: IQueryContext
        Convert the value to a string. For example the converter might be String.valueOf(Integer)
        Specified by:
        convertToString in interface IQueryContext
        Overrides:
        convertToString in class QueryContextImpl
        Parameters:
        type - The Java type of the argument.
        advice - Further details about the argument.
        value - The value of the argument held in the context.
        Returns:
        the value converted to a String
        Throws:
        SnapshotException - If there is a problem with the conversion such as the value is not a valid object ID.
      • parses

        public boolean parses​(Class<?> type,
                              Argument.Advice advice)
        Description copied from interface: IQueryContext
        Is special parsing required to get an object of the required type?
        Parameters:
        type - The Java type of the argument.
        advice - Further details about the argument.
        Returns:
        true if special parsing is needed, for example for a heap object or class object in the heap.
      • parse

        public Object parse​(Class<?> type,
                            Argument.Advice advice,
                            String[] args,
                            ParsePosition pos)
                     throws SnapshotException
        Description copied from interface: IQueryContext
        Consume the special data. For example using the ArgumentParser for data from a query wizard.
        Parameters:
        type - The Java type of the destination argument.
        advice - Further details about the argument.
        args - The source to be converted
        pos - Used to index through the array of Strings.
        Returns:
        the result of parsing the data suitable given the type and advice
        Throws:
        SnapshotException - If there is a problem in the parsing.
      • getContextDerivedData

        public ContextDerivedData getContextDerivedData()
        Description copied from interface: IQueryContext
        For example, retained size derived data.
        Returns:
        the derived data