GrepCode: org.apache.wicket.util.value.IValueMap (.java) - Interface

Maven-Central
/
org.apache.wicket / wicket
/
1.3.6

1.4.19
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.7
1.3.6
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.3.0-rc2
1.3.0-beta2
/
org.apache.wicket.util.value.IValueMap

Find Usages

Diff

Raw

Download

HTML Widget

Stack Overflow Questions

/*

   * 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.wicket.util.value;

 import java.util.Map;

 import org.apache.wicket.util.string.StringValue;

 import org.apache.wicket.util.string.StringValueConversionException;

 import org.apache.wicket.util.time.Duration;

 import org.apache.wicket.util.time.Time;

A Map interface that holds values, parses Strings, and exposes a variety of convenience methods.

Author(s):: Johan Compagner
Since:: 1.2.6

 public interface IValueMap extends Map

See also:: java.util.Map.clear()

 	void clear();

Retrieves a boolean value by key.

Parameters:: key the key
Returns:: the value
Throws:: org.apache.wicket.util.string.StringValueConversionException

 	boolean getBoolean(final String key) throws StringValueConversionException;

Retrieves a double value by key.

Parameters:: key the key
Returns:: the value
Throws:: org.apache.wicket.util.string.StringValueConversionException

 	double getDouble(final String key) throws StringValueConversionException;

Retrieves a double value by key, using a default value if not found.

Parameters:: key the key; defaultValue value to use if no value is in this IValueMap
Returns:: the value
Throws:: org.apache.wicket.util.string.StringValueConversionException

 	double getDouble(final String key, final double defaultValue)

 			throws StringValueConversionException;

Retrieves a Duration by key.

Parameters:: key the key
Returns:: the Duration value
Throws:: org.apache.wicket.util.string.StringValueConversionException

 	Duration getDuration(final String key) throws StringValueConversionException;

Retrieves an int value by key.

Parameters:: key the key
Returns:: the value
Throws:: org.apache.wicket.util.string.StringValueConversionException

 	int getInt(final String key) throws StringValueConversionException;

Retrieves an int value by key, using a default value if not found.

Parameters:: key the key; defaultValue value to use if no value is in this IValueMap
Returns:: the value
Throws:: org.apache.wicket.util.string.StringValueConversionException

	int getInt(final String key, final int defaultValue) throws StringValueConversionException;

Retrieves a long value by key.

Parameters:: key the key
Returns:: the value
Throws:: org.apache.wicket.util.string.StringValueConversionException

	long getLong(final String key) throws StringValueConversionException;

Retrieves a long value by key, using a default value if not found.

Parameters:: key the key; defaultValue value to use if no value in this IValueMap
Returns:: the value
Throws:: org.apache.wicket.util.string.StringValueConversionException

	long getLong(final String key, final long defaultValue) throws StringValueConversionException;

Retrieves a String by key, using a default value if not found.

Parameters:: key the key; defaultValue default value to return if value is null
Returns:: the String

	String getString(final String key, final String defaultValue);

Retrieves a String by key.

Parameters:: key the key
Returns:: the String

	String getString(final String key);

Retrieves a CharSequence by key.

Parameters:: key the key
Returns:: the CharSequence

	CharSequence getCharSequence(final String key);

Retrieves a String array by key. If the value was a String[] it will be returned directly. If it was a String it will be converted to a String array of length one. If it was an array of another type, a String array will be made and each element will be converted to a String.

Parameters:: key the key
Returns:: the String array of that key

	String[] getStringArray(final String key);

Retrieves a StringValue object by key.

Parameters:: key the key
Returns:: the StringValue object

	StringValue getStringValue(final String key);

Retrieves a Time object by key.

Parameters:: key the key
Returns:: the Time object
Throws:: org.apache.wicket.util.string.StringValueConversionException

	Time getTime(final String key) throws StringValueConversionException;

Returns whether or not this IValueMap is immutable.

Returns:: whether or not this IValueMap is immutable

	boolean isImmutable();

Makes this IValueMap immutable by changing the underlying map representation to a Collections.unmodifiableMap. After calling this method, any attempt to modify this IValueMap will result in a RuntimeException being thrown by the Collections framework.

Returns:: this IValueMap

	IValueMap makeImmutable();

See also:: java.util.Map.put(java.lang.Object,java.lang.Object)

	Object put(final Object key, final Object value);

See also:: java.util.Map.putAll(java.util.Map)

	void putAll(final Map map);

See also:: java.util.Map.remove(java.lang.Object)

	Object remove(final Object key);

Provided that the hash key is a String and you need to access the value ignoring the key's case (upper- or lowercase letters), then you may use this method to get the correct writing.

Parameters:: key the key
Returns:: the key with the correct writing

	String getKey(final String key);