com.github.hateoas.forms.action.StringOptions Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2014. Escalon System-Entwicklung, Dietrich Schulten
 *
 * 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.github.hateoas.forms.action;

import java.util.List;

import com.github.hateoas.forms.affordance.ActionDescriptor;
import com.github.hateoas.forms.affordance.SimpleSuggest;
import com.github.hateoas.forms.affordance.Suggest;
import com.github.hateoas.forms.affordance.SuggestObjectWrapper;

public class StringOptions implements Options> {

	/**
	 * Allows to specify possible values for an argument. This allows an {@link ActionDescriptor} to determine possible
	 * values for an action argument. The example below defines four possible values for the mood parameter.
	 * 
	 * 	 * @RequestMapping(value = "/customer", method = RequestMethod.GET, params = { "mood" })
	 * public HttpEntity<SamplePersonResourcegt; showPersonByMood(
	 *     @RequestParam @Select({ "angry", "happy", "grumpy", "bored" })
	 *     String mood) {
	 *     ...
	 * }
	 * 
	 */
	@Override
	public List>> get(String[] value, Object... args) {
		return SimpleSuggest.wrap(value);
	}
}