Package com.luciad.lucy.util.properties.codec

Interface ILcyPropertiesEncoder

All Known Implementing Classes:
TLcyStringPropertiesCodec
public interface ILcyPropertiesEncoder

Writes ALcyProperties to files or other types of storage.

The supported types of storage and ALcyProperties objects are defined by the actual implementations of this interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canEncode(ALcyProperties aProps, String aDestinationName)
    Returns whether this encoder can export the specified properties to the specified destination.
    void
    encode(ALcyProperties aProps, String aDestinationName)
    Encodes the given ALcyProperties into the given destination.

  • Method Details

    • canEncode

      boolean canEncode(ALcyProperties aProps, String aDestinationName)

      Returns whether this encoder can export the specified properties to the specified destination.

      This method will typically check whether the contents of the specified properties are compatible with the format this encoder is written for.

      Parameters:
      aProps - the properties to be verified.
      aDestinationName - the location where the properties should be exported to.
      Returns:
      true if this encoder can encode the specified properties to the specified location, false otherwise.
      See Also:

    • encode

      void encode(ALcyProperties aProps, String aDestinationName) throws IOException

      Encodes the given ALcyProperties into the given destination.

      Parameters:
      aProps - The properties to encode.
      aDestinationName - The destination name to encode to.
      Throws:
      IOException - In case of IO failure.