Package velox.api.layer1.messages

Interface Layer1ApiAliasAwareUserMessage

All Known Subinterfaces:
Layer1ApiAliasAwareTradingUserMessage
All Known Implementing Classes:
Layer1ApiIsTradingSupportedForAlias
public interface Layer1ApiAliasAwareUserMessage
Interface for any user messages (sent via Layer1ApiAdminProvider.sendUserMessage(java.lang.Object) or via Layer1ApiAdminListener.onUserMessage(java.lang.Object)) that are aware of instrument alias.

Allows reading and/or overriding an alias without caring about the specific message instance.

Important: Currently not all user messages implement this interface, so you should not rely on this interface for any message that is really aware of alias. But it could be used as a last fallback if you want to handle all alias-aware messages.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAlias()
    Instrument alias the message is related to.
    Layer1ApiAliasAwareUserMessage
    withAlias(String alias)
    Returns a copy of this message, but with a new alias, while all other data stays the same.

  • Method Details

    • getAlias

      String getAlias()
      Instrument alias the message is related to.
      Returns:
      instrument alias

    • withAlias

      Layer1ApiAliasAwareUserMessage withAlias(String alias)
      Returns a copy of this message, but with a new alias, while all other data stays the same.
      Parameters:
      alias - instrument alias for a message copy
      Returns:
      a copy of message with a new alias