git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.digiplex.internal.communication;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17
  18 /**
  19  * Response for {@link AreaLabelRequest}
  20  *
  21  * @author Robert Michalak - Initial contribution
  22  *
  23  */
  24 @NonNullByDefault
  25 public class AreaLabelResponse extends AbstractResponse {
  26
  27     public final int areaNo;
  28     public final @Nullable String areaName;
  29
  30     private AreaLabelResponse(int areaNo, String areaName) {
  31         super(true);
  32         this.areaNo = areaNo;
  33         this.areaName = areaName;
  34     }
  35
  36     private AreaLabelResponse(int areaNo) {
  37         super(false);
  38         this.areaNo = areaNo;
  39         this.areaName = null;
  40     }
  41
  42     /**
  43      * Builds a response for a given areaNo. Indicates that request failed.
  44      */
  45
  46     public static AreaLabelResponse failure(int areaNo) {
  47         return new AreaLabelResponse(areaNo);
  48     }
  49
  50     /**
  51      * Builds a response for a given areaNo and areaName. Indicates that request was successful.
  52      */
  53     public static AreaLabelResponse success(int areaNo, String areaName) {
  54         return new AreaLabelResponse(areaNo, areaName);
  55     }
  56
  57     @Override
  58     public void accept(DigiplexMessageHandler visitor) {
  59         visitor.handleAreaLabelResponse(this);
  60     }
  61 }