com.helger.photon.security.role.IRoleContainer Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014-2023 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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 com.helger.photon.security.role;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.ICommonsSet;

/**
 * Base read-only interface for objects containing roles.
 *
 * @author Philip Helger
 */
public interface IRoleContainer
{
  /**
   * @return true if at least one role is contained,
   *         false otherwise.
   */
  boolean hasContainedRoles ();

  /**
   * @return The number of contained roles. Always ≥ 0.
   */
  @Nonnegative
  int getContainedRoleCount ();

  /**
   * @return A non-nullbut maybe empty set of all assigned role
   *         IDs.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsSet  getAllContainedRoleIDs ();

  /**
   * Check if the passed role is contained in this container.
   *
   * @param sRoleID
   *        The role ID to check. May be null.
   * @return true if the role is contained in this container,
   *         false otherwise.
   */
  boolean containsRoleID (String sRoleID);
}