io.sarl.api.naming.name.ProtocolName Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api.naming Show documentation
Naming Library of the SARL SDK
The newest version!
/**
 * $Id$
 * 
 * SARL is an general-purpose agent programming language.
 * More details on http://www.sarl.io
 * 
 * Copyright (C) 2014-2024 SARL.io, the Original Authors and Main Authors
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.sarl.api.naming.name;

import io.sarl.lang.core.annotation.PrivateAPI;
import io.sarl.lang.core.annotation.SarlElementType;
import io.sarl.lang.core.annotation.SarlSpecification;
import io.sarl.lang.core.annotation.SyntheticMember;
import java.net.URI;
import java.util.Objects;
import java.util.UUID;
import org.eclipse.xtend.lib.annotations.Accessors;
import org.eclipse.xtext.xbase.lib.Pure;
import org.eclipse.xtext.xbase.lib.XbaseGenerated;

/**
 * This class represents a protocol name.
 * 
 * The component of a protocol name is: 

 * {@code protocolId} (mandatory) : the identifier of the protocol instance.
 * 
 * 
 * @author Stéphane Galland
 * @version api.naming 0.14.0 20241106-161408
 * @mavengroupid io.sarl.sdk
 * @mavenartifactid api.naming
 * @since 0.14
 */
@SarlSpecification("0.14")
@SarlElementType(10)
@XbaseGenerated
@SuppressWarnings("all")
public class ProtocolName extends SarlName {
  /**
   * Scheme for protocols.
   */
  public static final String SCHEME = "protocol";

  @Accessors
  private final UUID protocolId;

  /**
   * Constructor.
   * 
   * @param uri the uri of the protocol.
   * @param protocolId the identifier of the protocol.
   */
  @PrivateAPI
  public ProtocolName(final URI uri, final UUID protocolId) {
    super(uri);
    this.protocolId = protocolId;
  }

  @Override
  @Pure
  @SyntheticMember
  public boolean equals(final Object obj) {
    if (this == obj)
      return true;
    if (obj == null)
      return false;
    if (getClass() != obj.getClass())
      return false;
    ProtocolName other = (ProtocolName) obj;
    if (!Objects.equals(this.protocolId, other.protocolId))
      return false;
    return super.equals(obj);
  }

  @Override
  @Pure
  @SyntheticMember
  public int hashCode() {
    int result = super.hashCode();
    final int prime = 31;
    result = prime * result + Objects.hashCode(this.protocolId);
    return result;
  }

  @Override
  @Pure
  @SyntheticMember
  public ProtocolName clone() {
    try {
      return (ProtocolName) super.clone();
    } catch (Throwable exception) {
      throw new Error(exception);
    }
  }

  @SyntheticMember
  private static final long serialVersionUID = -2244628035L;

  @Pure
  public UUID getProtocolId() {
    return this.protocolId;
  }
}