edu.internet2.middleware.grouper.ws.query.StemScope Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grouper-ws Show documentation

Internet2 Groups Management WS Core

There is a newer version: 5.13.5

/*******************************************************************************
 * Copyright 2012 Internet2
 * 
 * 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.
 ******************************************************************************/
/*
 * @author mchyzer $Id: StemScope.java,v 1.3 2008-03-29 10:50:44 mchyzer Exp $
 */
package edu.internet2.middleware.grouper.ws.query;

import edu.internet2.middleware.grouper.Stem.Scope;
import edu.internet2.middleware.grouper.ws.util.GrouperServiceUtils;

/**
 * scope of groups under a stem.  either all or just one level (immediate)
 */
public enum StemScope {

  /** just direct immediate chlidren */
  ONE_LEVEL {

    /**
     * convert this to a real Grouper scope
     * @return the scope
     */
    @Override
    public Scope convertToScope() {
      return Scope.ONE;
    }
  },

  /** all children in the subtree below the stem */
  ALL_IN_SUBTREE {

    /**
     * convert this to a real Grouper scope
     * @return the scope
     */
    @Override
    public Scope convertToScope() {
      return Scope.SUB;
    }
  };

  /**
   * do a case-insensitive matching
   * 
   * @param string
   * @return the enum or null or exception if not found
   */
  public static StemScope valueOfIgnoreCase(String string) {
    return GrouperServiceUtils.enumValueOfIgnoreCase(StemScope.class, string, false);
  }

  /**
   * convert this to a real Grouper scope
   * @return the scope
   */
  public abstract Scope convertToScope();
}