/**
 *  Copyright © 2025, Luis Andrés Lange <https://javacomm.net>
 *
 *  Previously released under Apache License 2.0; now licensed under MPL 2.0.
 *
 *  This Source Code Form is subject to the terms of the Mozilla Public
 *  License, v. 2.0. If a copy of the MPL was not distributed with this
 *  file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 *  ----------------------------------------------------------------------------
 *
 *  Exhibit B - "Incompatible With Secondary Licenses" Notice
 *
 *  This Source Code Form is "Incompatible With Secondary Licenses",
 *  as defined by the Mozilla Public License, v. 2.0.
 *
 *  In short:
 *  - This file may be used, modified, and distributed under MPL 2.0 only.
 *  - It may NOT be relicensed under GPL, LGPL, AGPL, or any other Secondary License.
 *
 *  Rationale:
 *  - Ensures that the code remains MPL-2.0.
 *  - Avoids legal conflicts with GPL-licensed libraries (e.g., VideoLAN).
 *  - Maximizes usability for commercial and security-critical applications.
 *
 */
package net.javacomm.protocol;

import java.util.stream.Stream;



/**
 * Der Agent wird beim USRLOGIN verwendet. Er besagt, mit welcher Geräteklasse
 * der Anwender sich anmeldete. Der Server benötigt diese Information, um
 * bestimmte Funktionen freizuschalten oder zu blocken.
 * 
 */
public enum Agent {
  Desktop(0),
  Browser(1),
  Tablet(2),
  SmartPhone(3);

  private int id;

  private Agent(int id) {
    this.id = id;
  }



  /**
   * Gib die Client {@code id} vom Agent zurück.
   * 
   * @return diese id
   */
  public int idValue() {
    return id;
  }



  /**
   * Wandle den id Wert in einen Agent um.
   * 
   * @param id
   *           diese id
   * 
   * @return dieser Agent ist ein Desktop, Browser, Tablet oder SmartPhone
   */
  public static Agent toAgent(int id) {
    return Stream.of(Agent.values()).filter(enumId -> enumId.idValue() == id).findFirst()
        .orElseThrow(() -> new IllegalArgumentException("No enum constant with value " + id));
  }
}
