Package io.openems.edge.common.channel

Record Class ChannelId.ChannelIdImpl

java.lang.Object
java.lang.Record
io.openems.edge.common.channel.ChannelId.ChannelIdImpl
All Implemented Interfaces:
ChannelId
Enclosing interface:
ChannelId
public static record ChannelId.ChannelIdImpl(String name, Doc doc) extends Record implements ChannelId
The preferred way to define ChannelIds in OpenEMS Edge is via an enum that inherits ChannelId: 

 public enum ChannelId implements io.openems.edge.common.channel.ChannelId {
 	MY_CHANNEL(Doc.of(OpenemsType.INTEGER));
 
 	private final Doc doc;
 
 	private ChannelId(Doc doc) {
 		this.doc = doc;
 	}
 
 	@Override
 	public Doc doc() {
 		return this.doc;
 	}
 }

If instead you need to dynamically create ChannelIds at runtime - e.g. because at compile time you do not know the exact number of battery modules of a battery system - you may use ChannelId.ChannelIdImpl manually.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface io.openems.edge.common.channel.ChannelId

    ChannelId.ChannelIdImpl

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChannelIdImpl(String name, Doc doc)
    Creates an instance of a ChannelIdImpl record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Doc
    doc()
    Returns the value of the doc record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface io.openems.edge.common.channel.ChannelId

    id

  • Constructor Details

    • ChannelIdImpl

      public ChannelIdImpl(String name, Doc doc)
      Creates an instance of a ChannelIdImpl record class.
      Parameters:
      name - the value for the name record component
      doc - the value for the doc record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Specified by:
      name in interface ChannelId
      Returns:
      the value of the name record component

    • doc

      public Doc doc()
      Returns the value of the doc record component.
      Specified by:
      doc in interface ChannelId
      Returns:
      the value of the doc record component