diff --git a/Javadoc/allclasses-frame.html b/Javadoc/allclasses-frame.html index 6db061a6..83527ff6 100644 --- a/Javadoc/allclasses-frame.html +++ b/Javadoc/allclasses-frame.html @@ -2,9 +2,9 @@ - + All Classes - + @@ -28,18 +28,25 @@
  • AsyncRunnable
  • BackgroundCompiler
  • BannedGenerator
    • +
  • BasicErrorReporter
  • BlockingHashMap
    • +
  • BlockingHashMapTest
  • BukkitCloner
  • BukkitConverters
    • +
  • BukkitInitialization
  • ChatExtensions
  • ChunkPosition
  • Cloner
  • CollectionCloner
  • CollectionGenerator
    • +
  • CommandFilter
    • +
  • CommandFilter.Filter
    • +
  • CommandFilter.FilterFailedHandler
  • CompiledStructureModifier
  • CompileListener
  • ConnectionSide
  • DefaultInstances
    • +
  • DelegatedErrorReporter
  • DetailedErrorReporter
  • EquivalentConverter
  • ErrorReporter
    • @@ -68,12 +75,18 @@
  • Metrics.Plotter
  • MinecraftMethods
  • MinecraftReflection
    • +
  • MinecraftVersion
    • +
  • MinecraftVersionTest
  • MonitorAdapter
  • NbtBase
  • NbtBinarySerializer
  • NbtCompound
    • +
  • NbtCompoundTest
    • +
  • NbtCompoundTest.NbtCustomTag
  • NbtConfigurationSerializer
    • +
  • NbtConfigurationSerializerTest
  • NbtFactory
    • +
  • NbtFactoryTest
  • NbtList
  • NbtTextSerializer
  • NbtType
    • @@ -84,6 +97,7 @@
  • ObjectWriter
  • PacketAdapter
  • PacketContainer
    • +
  • PacketContainerTest
  • PacketEvent
  • PacketListener
  • Packets
    • @@ -94,11 +108,16 @@
  • PrimitiveGenerator
  • ProtocolLibrary
  • ProtocolManager
    • +
  • Report
    • +
  • Report.ReportBuilder
    • +
  • ReportType
  • SortedCopyOnWriteArray
    • +
  • SortedCopyOnWriteArrayTest
  • Statistics
  • StreamSerializer
  • StructureCompiler
  • StructureModifier
    • +
  • TroveWrapper
  • Updater
  • Updater.UpdateResult
  • Updater.UpdateType
    • diff --git a/Javadoc/allclasses-noframe.html b/Javadoc/allclasses-noframe.html index d064008c..bb9aee4b 100644 --- a/Javadoc/allclasses-noframe.html +++ b/Javadoc/allclasses-noframe.html @@ -2,9 +2,9 @@ - + All Classes - + @@ -28,18 +28,25 @@
  • AsyncRunnable
  • BackgroundCompiler
  • BannedGenerator
    • +
  • BasicErrorReporter
  • BlockingHashMap
    • +
  • BlockingHashMapTest
  • BukkitCloner
  • BukkitConverters
    • +
  • BukkitInitialization
  • ChatExtensions
  • ChunkPosition
  • Cloner
  • CollectionCloner
  • CollectionGenerator
    • +
  • CommandFilter
    • +
  • CommandFilter.Filter
    • +
  • CommandFilter.FilterFailedHandler
  • CompiledStructureModifier
  • CompileListener
  • ConnectionSide
  • DefaultInstances
    • +
  • DelegatedErrorReporter
  • DetailedErrorReporter
  • EquivalentConverter
  • ErrorReporter
    • @@ -68,12 +75,18 @@
  • Metrics.Plotter
  • MinecraftMethods
  • MinecraftReflection
    • +
  • MinecraftVersion
    • +
  • MinecraftVersionTest
  • MonitorAdapter
  • NbtBase
  • NbtBinarySerializer
  • NbtCompound
    • +
  • NbtCompoundTest
    • +
  • NbtCompoundTest.NbtCustomTag
  • NbtConfigurationSerializer
    • +
  • NbtConfigurationSerializerTest
  • NbtFactory
    • +
  • NbtFactoryTest
  • NbtList
  • NbtTextSerializer
  • NbtType
    • @@ -84,6 +97,7 @@
  • ObjectWriter
  • PacketAdapter
  • PacketContainer
    • +
  • PacketContainerTest
  • PacketEvent
  • PacketListener
  • Packets
    • @@ -94,11 +108,16 @@
  • PrimitiveGenerator
  • ProtocolLibrary
  • ProtocolManager
    • +
  • Report
    • +
  • Report.ReportBuilder
    • +
  • ReportType
  • SortedCopyOnWriteArray
    • +
  • SortedCopyOnWriteArrayTest
  • Statistics
  • StreamSerializer
  • StructureCompiler
  • StructureModifier
    • +
  • TroveWrapper
  • Updater
  • Updater.UpdateResult
  • Updater.UpdateType
    • diff --git a/Javadoc/com/comphenix/protocol/Application.html b/Javadoc/com/comphenix/protocol/Application.html index 6edc7b9b..48e39b14 100644 --- a/Javadoc/com/comphenix/protocol/Application.html +++ b/Javadoc/com/comphenix/protocol/Application.html @@ -2,9 +2,9 @@ - + Application - + diff --git a/Javadoc/com/comphenix/protocol/AsynchronousManager.html b/Javadoc/com/comphenix/protocol/AsynchronousManager.html index 492414a4..3613e920 100644 --- a/Javadoc/com/comphenix/protocol/AsynchronousManager.html +++ b/Javadoc/com/comphenix/protocol/AsynchronousManager.html @@ -2,9 +2,9 @@ - + AsynchronousManager - + @@ -37,7 +37,7 @@
    @@ -699,6 +767,8 @@ implements

    getErrorCount

    public int getErrorCount()
    +
    Retrieve the current number of errors printed through reportDetailed(Object, Report).
    +
    Returns:
    Number of errors printed.
    @@ -708,6 +778,8 @@ implements

    setErrorCount

    public void setErrorCount(int errorCount)
    +
    Set the number of errors printed.
    +
    Parameters:
    errorCount - - new number of errors printed.
     @@ -717,6 +789,8 @@ implements

    getMaxErrorCount

    public int getMaxErrorCount()
    +
    Retrieve the maximum number of errors we can print before we begin suppressing errors.
    +
    Returns:
    Maximum number of errors.
     @@ -726,6 +800,8 @@ implements

    setMaxErrorCount

    public void setMaxErrorCount(int maxErrorCount)
    +
    Set the maximum number of errors we can print before we begin suppressing errors.
    +
    Parameters:
    maxErrorCount - - new max count.
     @@ -736,7 +812,9 @@ implements addGlobalParameter 
    public void addGlobalParameter(java.lang.String key,
                       java.lang.Object value)
    -
    Adds the given global parameter. It will be included in every error report.
    +
    Adds the given global parameter. It will be included in every error report. +

    + Both key and value must be non-null.

    Parameters:
    key - - name of parameter.
    value - - the global parameter itself.
    @@ -747,6 +825,9 @@ implements

    getGlobalParameter

    public java.lang.Object getGlobalParameter(java.lang.String key)
    +
    Retrieve a global parameter by its key.
    +
    Parameters:
    key - - key of the parameter to retrieve.
    +
    Returns:
    The value of the global parameter, or NULL if not found.
     @@ -756,6 +837,7 @@ implements

    clearGlobalParameters

    public void clearGlobalParameters()
    +
    Reset all global parameters.
     @@ -765,6 +847,8 @@ implements

    globalParameters

    public java.util.Set<java.lang.String> globalParameters()
    +
    Retrieve a set of every registered global parameter.
    +
    Returns:
    Set of all registered global parameters.
     @@ -774,6 +858,8 @@ implements

    getSupportURL

    public java.lang.String getSupportURL()
    +
    Retrieve the support URL that will be added to all detailed reports.
    +
    Returns:
    Support URL.
     @@ -783,6 +869,8 @@ implements

    setSupportURL

    public void setSupportURL(java.lang.String supportURL)
    +
    Set the support URL that will be added to all detailed reports.
    +
    Parameters:
    supportURL - - the new support URL.
     @@ -792,6 +880,8 @@ implements

    getPrefix

    public java.lang.String getPrefix()
    +
    Retrieve the prefix to apply to every line in the error reports.
    +
    Returns:
    Error report prefix.
     @@ -801,6 +891,8 @@ implements

    setPrefix

    public void setPrefix(java.lang.String prefix)
    +
    Set the prefix to apply to every line in the error reports.
    +
    Parameters:
    prefix - - new prefix.
     @@ -810,6 +902,8 @@ implements

    getLogger

    public java.util.logging.Logger getLogger()
    +
    Retrieve the current logger that is used to print all reports.
    +
    Returns:
    The current logger.
     @@ -819,6 +913,8 @@ implements

    setLogger

    public void setLogger(java.util.logging.Logger logger)
    +
    Set the current logger that is used to print all reports.
    +
    Parameters:
    logger - - new logger.
    @@ -847,7 +943,7 @@ implements
    @@ -190,47 +197,56 @@ java.lang.String methodName, java.lang.Throwable error, java.lang.Object... parameters) -
    Prints a small minimal error report about an exception from another plugin.
    +
    Prints a small minimal error report regarding an exception from another plugin.
    Parameters:
    sender - - the other plugin.
    methodName - - name of the caller method.
    error - - the exception itself.
    parameters - - any relevant parameters to print.
    - + - + - + + + + + @@ -260,7 +276,7 @@
    • Frames
      • diff --git a/Javadoc/com/comphenix/protocol/error/Report.ReportBuilder.html b/Javadoc/com/comphenix/protocol/error/Report.ReportBuilder.html new file mode 100644 index 00000000..49ee8fa8 --- /dev/null +++ b/Javadoc/com/comphenix/protocol/error/Report.ReportBuilder.html @@ -0,0 +1,306 @@ + + + + + +Report.ReportBuilder + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      +
        +
      • Detail: 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      +
      + + +
      + + +
      +
      com.comphenix.protocol.error
      +

      Class Report.ReportBuilder

      +
      +
      +
        +
      • java.lang.Object
        • +
      • +
          +
        • com.comphenix.protocol.error.Report.ReportBuilder
          • +
        +
        • +
      +
      +
        +
      • +
        +
        Enclosing class:
        +
        Report
        +
        +
        +
        +
        public static class Report.ReportBuilder
+extends java.lang.Object
        +
        Must be constructed through the factory method in Report.
        +
        • +
      +
      +
      +
        +
      • + +
          +
        • + + +

          Method Summary

          + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Methods 
          Modifier and TypeMethod and Description
          Reportbuild() +
          Construct a new report with the provided input.
          +
          Report.ReportBuildercallerParam(java.lang.Object... callerParameters) +
          Set the parameters in the caller method.
          +
          Report.ReportBuildererror(java.lang.Throwable exception) +
          Set the current exception that occured.
          +
          Report.ReportBuildermessageParam(java.lang.Object... messageParameters) +
          Set the message parameters that are used to construct a message text.
          +
          Report.ReportBuildertype(ReportType type) +
          Set the current report type.
          +
          +
            +
          • + + +

            Methods inherited from class java.lang.Object

            +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            • +
          +
          • +
        +
        • +
      +
      +
      +
        +
      • + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            type

            +
            public Report.ReportBuilder type(ReportType type)
            +
            Set the current report type. Cannot be NULL.
            +
            Parameters:
            type - - report type.
            +
            Returns:
            This builder, for chaining.
            +
            • +
          + + + +
            +
          • +

            error

            +
            public Report.ReportBuilder error(@Nullable
+                         java.lang.Throwable exception)
            +
            Set the current exception that occured.
            +
            Parameters:
            exception - - exception that occured.
            +
            Returns:
            This builder, for chaining.
            +
            • +
          + + + +
            +
          • +

            messageParam

            +
            public Report.ReportBuilder messageParam(@Nullable
+                                java.lang.Object... messageParameters)
            +
            Set the message parameters that are used to construct a message text.
            +
            Parameters:
            messageParameters - - parameters for the report type.
            +
            Returns:
            This builder, for chaining.
            +
            • +
          + + + +
            +
          • +

            callerParam

            +
            public Report.ReportBuilder callerParam(@Nullable
+                               java.lang.Object... callerParameters)
            +
            Set the parameters in the caller method. This is optional.
            +
            Parameters:
            callerParameters - - parameters of the caller method.
            +
            Returns:
            This builder, for chaining.
            +
            • +
          + + + +
            +
          • +

            build

            +
            public Report build()
            +
            Construct a new report with the provided input.
            +
            Returns:
            A new report.
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      +
        +
      • Detail: 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      +
      + + +
      + + + diff --git a/Javadoc/com/comphenix/protocol/error/Report.html b/Javadoc/com/comphenix/protocol/error/Report.html new file mode 100644 index 00000000..ac28474f --- /dev/null +++ b/Javadoc/com/comphenix/protocol/error/Report.html @@ -0,0 +1,421 @@ + + + + + +Report + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      + + +
      + + +
      + + +
      +
      com.comphenix.protocol.error
      +

      Class Report

      +
      +
      +
        +
      • java.lang.Object
        • +
      • +
          +
        • com.comphenix.protocol.error.Report
          • +
        +
        • +
      +
      +
        +
      • +
        +
        +
        public class Report
+extends java.lang.Object
        +
        Represents a error or warning report.
        +
        Author:
        +
        Kristian
        +
        • +
      +
      +
      +
        +
      • + +
          +
        • + + +

          Nested Class Summary

          + + + + + + + + + + +
          Nested Classes 
          Modifier and TypeClass and Description
          static class Report.ReportBuilder +
          Must be constructed through the factory method in Report.
          +
          +
          • +
        + +
          +
        • + + +

          Constructor Summary

          + + + + + + + + + + +
          Constructors 
          ModifierConstructor and Description
          protected Report(ReportType type, + java.lang.Throwable exception, + java.lang.Object[] messageParameters, + java.lang.Object[] callerParameters) +
          Construct a new report with the given type and parameters.
          +
          +
          • +
        + +
          +
        • + + +

          Method Summary

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Methods 
          Modifier and TypeMethod and Description
          java.lang.Object[]getCallerParameters() +
          Retrieve the parameters of the caller method.
          +
          java.lang.ThrowablegetException() +
          Retrieve the associated exception, or NULL if not found.
          +
          java.lang.Object[]getMessageParameters() +
          Retrieve the message parameters that will be used to construc the report message.
          +
          java.lang.StringgetReportMessage() +
          Format the current report type with the provided message parameters.
          +
          ReportTypegetType() +
          Retrieve the report type.
          +
          booleanhasCallerParameters() +
          Determine if we have any caller parameters.
          +
          booleanhasMessageParameters() +
          Determine if we have any message parameters.
          +
          static Report.ReportBuildernewBuilder(ReportType type) +
          Construct a new report builder.
          +
          +
            +
          • + + +

            Methods inherited from class java.lang.Object

            +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            • +
          +
          • +
        +
        • +
      +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            Report

            +
            protected Report(ReportType type,
+      @Nullable
+      java.lang.Throwable exception,
+      @Nullable
+      java.lang.Object[] messageParameters,
+      @Nullable
+      java.lang.Object[] callerParameters)
            +
            Construct a new report with the given type and parameters.
            +
            Parameters:
            exception - - exception that occured in the caller method.
            type - - the report type that will be used to construct the message.
            messageParameters - - parameters used to construct the report message.
            callerParameters - - parameters from the caller method.
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            newBuilder

            +
            public static Report.ReportBuilder newBuilder(ReportType type)
            +
            Construct a new report builder.
            +
            Parameters:
            type - - the initial report type.
            +
            Returns:
            Report builder.
            +
            • +
          + + + +
            +
          • +

            getReportMessage

            +
            public java.lang.String getReportMessage()
            +
            Format the current report type with the provided message parameters.
            +
            Returns:
            The formated report message.
            +
            • +
          + + + +
            +
          • +

            getMessageParameters

            +
            public java.lang.Object[] getMessageParameters()
            +
            Retrieve the message parameters that will be used to construc the report message. + +
            Returns:
            Message parameters.
            +
            • +
          + + + +
            +
          • +

            getCallerParameters

            +
            public java.lang.Object[] getCallerParameters()
            +
            Retrieve the parameters of the caller method. Optional - may be NULL.
            +
            Returns:
            Parameters or the caller method.
            +
            • +
          + + + +
            +
          • +

            getType

            +
            public ReportType getType()
            +
            Retrieve the report type.
            +
            Returns:
            Report type.
            +
            • +
          + + + +
            +
          • +

            getException

            +
            public java.lang.Throwable getException()
            +
            Retrieve the associated exception, or NULL if not found.
            +
            Returns:
            Associated exception, or NULL.
            +
            • +
          + + + +
            +
          • +

            hasMessageParameters

            +
            public boolean hasMessageParameters()
            +
            Determine if we have any message parameters.
            +
            Returns:
            TRUE if there are any message parameters, FALSE otherwise.
            +
            • +
          + + + +
            +
          • +

            hasCallerParameters

            +
            public boolean hasCallerParameters()
            +
            Determine if we have any caller parameters.
            +
            Returns:
            TRUE if there are any caller parameters, FALSE otherwise.
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      + + +
      + + +
      + + + diff --git a/Javadoc/com/comphenix/protocol/injector/BukkitUnwrapper.html b/Javadoc/com/comphenix/protocol/error/ReportType.html similarity index 58% rename from Javadoc/com/comphenix/protocol/injector/BukkitUnwrapper.html rename to Javadoc/com/comphenix/protocol/error/ReportType.html index 702c0482..e6f8a41d 100644 --- a/Javadoc/com/comphenix/protocol/injector/BukkitUnwrapper.html +++ b/Javadoc/com/comphenix/protocol/error/ReportType.html @@ -2,15 +2,15 @@ - -BukkitUnwrapper - + +ReportType + @@ -27,7 +27,7 @@
    • Overview
    • Package
    • Class
      • -
    • Use
      • +
    • Use
    • Tree
    • Deprecated
    • Index
      • @@ -36,12 +36,12 @@