com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

com.aspose.pdf

Class LoadOptions.ResourceLoadingResult

  • Enclosing class:
    LoadOptions


    public static class LoadOptions.ResourceLoadingResult
    extends Object

    Result of custom loading of resource

    • Constructor Detail

      • ResourceLoadingResult

        public ResourceLoadingResult(byte[] data)

        Creates instance of loading result

        Parameters:
        data - reult of custom loading must be allways provided, it can be zero-length array if it's impossible to get any result
    • Method Detail

      • getData

        public byte[] getData()

        Bynary data that loaded with custom loader - it must be set after loading

        Returns:
        array of byte values
      • getEncodingIfKnown

        public Charset getEncodingIfKnown()

        Sometimes encoding of resource is known after or during loading. In such case custom code can provide converter with that knowledge via this parameter. You can leave null in this parameter if encoding is unknown or does not matter.

        Returns:
        Charset instance
      • setEncodingIfKnown

        public void setEncodingIfKnown(Charset encodingIfKnown)

        Sometimes encoding of resource is known after or during loading. In such case custom code can provide converter with that knowledge via this parameter. You can leave null in this parameter if encoding is unknown or does not matter.

        Parameters:
        encodingIfKnown - Charset instance
      • getExceptionOfLoadingIfAny

        public com.aspose.ms.System.Exception getExceptionOfLoadingIfAny()

        Sometimes it's impossible to load requested resource for some reason. Unavailability of resource often does not lead to crash of conversions and result document can be created anyway(but maybe in a bit worse quality, without images etc.). If exception occurred during loading, just catch it and put in this parameter - sometimes that information is useful for converter for rendering of result.

        Returns:
        Exception
      • setExceptionOfLoadingIfAny

        public void setExceptionOfLoadingIfAny(com.aspose.ms.System.Exception exceptionOfLoadingIfAny)

        Sometimes it's impossible to load requested resource for some reason. Unavailability of resource often does not lead to crash of conversions and result document can be created anyway(but maybe in a bit worse quality, without images etc.). If exception occurred during loading, just catch it and put in this parameter - sometimes that information is useful for converter for rendering of result.

        Parameters:
        exceptionOfLoadingIfAny - Exception
      • getMIMETypeIfKnown

        public String getMIMETypeIfKnown()

        Sometimes knowledge about MIME type of loaded resource is usefull for converter You can provide MIME type(if it'd known after loading) in this parameter. Please leave parameter equal to null when MIME type unknown or it's not necessary to supply it.

        Returns:
        String value
      • setMIMETypeIfKnown

        public void setMIMETypeIfKnown(String MIMETypeIfKnown)

        Sometimes knowledge about MIME type of loaded resource is usefull for converter You can provide MIME type(if it'd known after loading) in this parameter. Please leave parameter equal to null when MIME type unknown or it's not necessary to supply it.

        Parameters:
        MIMETypeIfKnown - String value
      • isLoadingCancelled

        public boolean isLoadingCancelled()

        Sometimes for some reasons loading should not occure custom code. In such case please set this flag as True. In such case converter will try use internal default resource loader to get that result(as it behave in situation when custom strategy not supplied).

        Returns:
        boolean value
      • setLoadingCancelled

        public void setLoadingCancelled(boolean loadingCancelled)

        Sometimes for some reasons loading should not occure custom code. In such case please set this flag as True. In such case converter will try use internal default resource loader to get that result(as it behave in situation when custom strategy not supplied).

        Parameters:
        loadingCancelled - boolean value