Class MapExternalizer

    • Constructor Detail

      • MapExternalizer

        public MapExternalizer()
    • Method Detail

      • writeObject

        public void writeObject​(ObjectOutput output,
                                Map map)
                         throws IOException
        Description copied from interface: Externalizer
        Write the object reference to the stream.
        Parameters:
        output - the object output to write to
        map - the object reference to write
        Throws:
        IOException - if an I/O error occurs
      • getId

        public Integer getId()
        Description copied from interface: AdvancedExternalizer
        Returns an integer that identifies the externalizer type. This is used at read time to figure out which AdvancedExternalizer should read the contents of the incoming buffer. Using a positive integer allows for very efficient variable length encoding of numbers, and it's much more efficient than shipping AdvancedExternalizer implementation class information around. Negative values are not allowed. Implementers of this interface can use any positive integer as long as it does not clash with any other identifier in the system. You can find information on the pre-assigned identifier ranges in here. It's highly recommended that maintaining of these identifiers is done in a centralized way and you can do so by making annotations reference a set of statically defined identifiers in a separate class or interface. Such class/interface gives a global view of the identifiers in use and so can make it easier to assign new ids. Implementors can optionally avoid giving a meaningful implementation to this method (i.e. return null) and instead rely on XML or programmatic configuration to provide the AdvancedExternalizer id. If no id can be determined via the implementation or XML/programmatic configuration, an error will be reported. If an id has been defined both via the implementation and XML/programmatic configuration, the value defined via XML/programmatic configuration will be used ignoring the other.
        Specified by:
        getId in interface AdvancedExternalizer<Map>
        Overrides:
        getId in class AbstractExternalizer<Map>
        Returns:
        A positive identifier for the AdvancedExternalizer.
      • getTypeClasses

        public Set<Class<? extends Map>> getTypeClasses()
        Description copied from interface: AdvancedExternalizer
        Returns a collection of Class instances representing the types that this AdvancedExternalizer can marshall. Clearly, empty sets are not allowed. The externalizer framework currently requires all individual types to be listed since it does not make assumptions based on super classes or interfaces.
        Returns:
        A set containing the Class instances that can be marshalled.
      • getSupportedPrivateClasses

        public static Set<Class<? extends Map>> getSupportedPrivateClasses()
        Returns an immutable Set that contains all of the private classes (e.g. java.util.Collections$EmptyMap) that are supported by this Externalizer. This method is to be used by external sources if these private classes need additional processing to be available.
        Returns:
        immutable set of the private classes