org.apache.juneau.objecttools.ViewArgs Maven / Gradle / Ivy

Go to download
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you 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 org.apache.juneau.objecttools;

import static org.apache.juneau.common.internal.StringUtils.*;
import static org.apache.juneau.internal.CollectionUtils.*;

import java.util.*;

/**
 * Arguments passed to {@link ObjectViewer}.
 *
 * See Also:

 * 	Overview > juneau-marshall > Object Tools
 * 
 */
public class ViewArgs {

	//-----------------------------------------------------------------------------------------------------------------
	// Static
	//-----------------------------------------------------------------------------------------------------------------

	/**
	 * Static creator.
	 *
	 * @param args Comma-delimited list of view arguments.
	 * @return A new {@link ViewArgs} object.
	 */
	public static ViewArgs create(String args) {
		if (args == null) return null;
		return new ViewArgs(args);
	}

	/**
	 * Static creator.
	 *
	 * @param args List of view arguments.
	 * @return A new {@link ViewArgs} object.
	 */
	public static ViewArgs create(List args) {
		if (args == null) return null;
		return new ViewArgs(args);
	}

	//-----------------------------------------------------------------------------------------------------------------
	// Instance
	//-----------------------------------------------------------------------------------------------------------------

	private final List view;

	/**
	 * Constructor.
	 *
	 * @param viewArgs
	 * 	View arguments.
	 * 	
Values are column names.
	 */
	public ViewArgs(String viewArgs) {
		this(alist(split(viewArgs)));
	}

	/**
	 * Constructor.
	 *
	 * @param viewArgs
	 * 	View arguments.
	 * 	
Values are column names.
	 */
	public ViewArgs(Collection viewArgs) {
		this.view = unmodifiable(listFrom(viewArgs));
	}

	/**
	 * The view columns.
	 *
	 * 
	 * The view columns are the list of columns that should be displayed.
	 * An empty list implies all columns should be displayed.
	 *
	 * @return An unmodifiable list of columns to view.
	 */
	public List getView() {
		return view;
	}
}