001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.wicket.request.mapper.parameter; 018 019import org.apache.wicket.request.IRequestHandler; 020import org.apache.wicket.request.Url; 021 022/** 023 * Encoder that can encode and decode {@link PageParameters} to/from URL. 024 * 025 * @author Matej Knopp 026 */ 027public interface IPageParametersEncoder 028{ 029 /** 030 * Encode the given {@link PageParameters} instance into URL. The URL will be then merged with 031 * the URL generated for {@link IRequestHandler}. 032 * 033 * @param pageParameters 034 * parameters to encode 035 * @return Url generated from the page parameters 036 */ 037 Url encodePageParameters(PageParameters pageParameters); 038 039 /** 040 * Decodes the given URL to {@link PageParameters}. The URL will have all 041 * {@link IRequestHandler} specified segments/parameters stripped. 042 * 043 * @param url 044 * url to decode 045 * @return {@link PageParameters} instance or <code>null</code> if empty 046 */ 047 PageParameters decodePageParameters(Url url); 048}