io.sarl.api.naming.name.AgentName 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 an agent name.
 * 
 * The different components of an agent name are: 

 * {@code contextId} (optional) : the identifier of the context in which the agent is located.
 *     If it is {@code null}, the the {@code spaceId} component is equal to {@code null}.
 * {@code spaceId} (optional) : the identifier of the space in which the agent is registered.
 * {@code agentId} (mandatory) : the identifier of the agent.
 * 
 * 
 * @author Stéphane Galland
 * @version api.naming 0.14.0 20241106-161408
 * @mavengroupid io.sarl.sdk
 * @mavenartifactid api.naming
 * @since 0.12
 */
@SarlSpecification("0.14")
@SarlElementType(10)
@XbaseGenerated
@SuppressWarnings("all")
public class AgentName extends SarlName {
  /**
   * Scheme for agents.
   */
  public static final String SCHEME = "agent";

  @Accessors
  private final UUID contextId;

  @Accessors
  private final UUID spaceId;

  @Accessors
  private final UUID agentId;

  /**
   * Constructor.
   * 
   * @param uri the uri of the context.
   * @param contextId the identifier of the context.
   * @param spaceId the identifier of the space.
   * @param agentId the identifier of the agent.
   */
  @PrivateAPI
  public AgentName(final URI uri, final UUID contextId, final UUID spaceId, final UUID agentId) {
    super(uri);
    this.contextId = contextId;
    this.spaceId = spaceId;
    this.agentId = agentId;
  }

  @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;
    AgentName other = (AgentName) obj;
    if (!Objects.equals(this.contextId, other.contextId))
      return false;
    if (!Objects.equals(this.spaceId, other.spaceId))
      return false;
    if (!Objects.equals(this.agentId, other.agentId))
      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.contextId);
    result = prime * result + Objects.hashCode(this.spaceId);
    result = prime * result + Objects.hashCode(this.agentId);
    return result;
  }

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

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

  @Pure
  public UUID getContextId() {
    return this.contextId;
  }

  @Pure
  public UUID getSpaceId() {
    return this.spaceId;
  }

  @Pure
  public UUID getAgentId() {
    return this.agentId;
  }
}