Module aeonics.core

Class Channel

  • All Implemented Interfaces:
    Documented, Exportable

    public class Channel
    extends java.lang.Object
    implements Documented
    This class represents a channel for an Origin, Action or Destination entity. It provides a hint about possible variants of the action. It is used by the corresponding Template to create and populate new instances of the action.
    • Constructor Summary

      Constructors 
      Constructor Description
      Channel​(java.lang.String name)
      Creates a new channel
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String description()
      Returns the channel description
      <C extends Channel>
      C
      description​(java.lang.String value)
      Sets the channel description
      java.lang.String name()
      Returns the channel name
      java.lang.String summary()
      Returns the channel summary
      <C extends Channel>
      C
      summary​(java.lang.String value)
      Sets the channel summary
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Channel

        public Channel​(java.lang.String name)
        Creates a new channel
        Parameters:
        name - the channel name
        Throws:
        java.lang.IllegalArgumentException - if the name is null or blank.
    • Method Detail

      • name

        public java.lang.String name()
        Returns the channel name
        Specified by:
        name in interface Documented
        Returns:
        the channel name
      • summary

        public java.lang.String summary()
        Returns the channel summary
        Specified by:
        summary in interface Documented
        Returns:
        the channel summary
      • summary

        public <C extends Channel> C summary​(java.lang.String value)
        Sets the channel summary
        Type Parameters:
        C - this channel type
        Parameters:
        value - the summary
        Returns:
        this
      • description

        public java.lang.String description()
        Returns the channel description
        Specified by:
        description in interface Documented
        Returns:
        the channel description
      • description

        public <C extends Channel> C description​(java.lang.String value)
        Sets the channel description
        Type Parameters:
        C - this channel type
        Parameters:
        value - the description
        Returns:
        this