javax.portlet.RenderParameters Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portlet-api Show documentation
Show all versions of portlet-api Show documentation
The Java Portlet API version 3.0 developed by the Java Community Process JSR-362 Expert Group.
/* 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.
*/
/*
* This source code implements specifications defined by the Java
* Community Process. In order to remain compliant with the specification
* DO NOT add / change / or delete method signatures!
*/
package javax.portlet;
/**
*
* Provides access to render parameters, which make up part of the render state.
*
* @see PortletParameters
* @see MutableRenderParameters
* @since 3.0
*/
public interface RenderParameters extends PortletParameters
{
/**
*
* Returns a MutableRenderParameters
object encapsulating a copy of the same
* parameters as the original object.
* Changing a mutable copy will not influence the source object.
*
*
* @return Mutable clone of RenderParameters object
*
* @since 3.0
*/
public MutableRenderParameters clone();
/**
*
* Returns a boolean value indicating whether the given
* parameter name represents a public render parameter.
* Note that if true
is returned, it does not mean that a public
* render parameter value is set.
*
*
* @param name
* the parameter name
*
* @return true
if the given parameter
* name represents a public render parameter.
* false
otherwise
*
* @exception java.lang.IllegalArgumentException
* if name is null
.
*
* @since 3.0
*/
public boolean isPublic (String name);
}