plugins/org.eclipse.mat.ui.help/reference/inspections/group_by_value.dita

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd" >
<reference id="ref_inspections_group_by_value" xml:lang="en-us">
	<title>Group by Value</title>
	<shortdesc>Group a set of objects by value.
	</shortdesc>
	<prolog>
		<copyright>
			<copyryear year=""></copyryear>
			<copyrholder>
				Copyright (c) 2008, 2010 SAP AG and others.
			    All rights reserved. This program and the accompanying materials
			    are made available under the terms of the Eclipse Public License v1.0
			    which accompanies this distribution, and is available at
			    http://www.eclipse.org/legal/epl-v10.html
			</copyrholder>
		</copyright>
	</prolog>
	
	<refbody>
		<section>
			<title>Motivation</title>
			<p>Sometimes it is easier to understand the uses of instances of a class if the instances are
			grouped into sets where each object in the set has the same printable value as the others.</p>
		</section>
		<section>
			<title>Arguments</title>
			<simpletable>
				<sthead>
					<stentry>Argument</stentry>
					<stentry>Description</stentry>
				</sthead>
				<strow>
					<stentry>objects</stentry>
					<stentry>An arbitrary set of objects to arrange in sets by value.</stentry>
				</strow>
				<strow>
					<stentry>-field</stentry>
					<stentry>An optional dot notation to specify a field which is used to group the objects,
					e.g. modCount to group HashMaps by their modifications.</stentry>
				</strow>
			</simpletable>
		</section>
		<section id="result">
			<title>Result</title>
		</section>
	</refbody>
</reference>