org.sonar.server.usergroups.ws.WsGroupRef Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation

There is a newer version: 7.2.1

/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.usergroups.ws;

import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.sonar.api.server.ws.Request;

import static org.sonar.server.ws.WsUtils.checkRequest;

/**
 * Group from a WS request. Guaranties the group id or the group name is provided, not both.
 */
public class WsGroupRef {

  private final Long id;
  private final String name;

  private WsGroupRef(@Nullable Long id, @Nullable String name) {
    checkRequest(id != null ^ name != null, "Group name or group id must be provided, not both.");

    this.id = id;
    this.name = name;
  }

  public static WsGroupRef newWsGroupRef(@Nullable Long id, @Nullable String name) {
    return new WsGroupRef(id, name);
  }

  public static WsGroupRef newWsGroupRefFromUserGroupRequest(Request wsRequest) {
    Long id = wsRequest.paramAsLong(UserGroupsWsParameters.PARAM_GROUP_ID);
    String name = wsRequest.param(UserGroupsWsParameters.PARAM_GROUP_NAME);

    return new WsGroupRef(id, name);
  }

  @CheckForNull
  public Long id() {
    return this.id;
  }

  @CheckForNull
  public String name() {
    return this.name;
  }
}