JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
DimensionImmutable.java
Go to the documentation of this file.
1/**
2 * Copyright 2010 JogAmp Community. All rights reserved.
3 * Copyright (c) 2010 JogAmp Community. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification, are
6 * permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this list of
9 * conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 * of conditions and the following disclaimer in the documentation and/or other materials
13 * provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
16 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
17 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
18 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
21 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
22 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
23 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 *
25 * The views and conclusions contained in the software and documentation are those of the
26 * authors and should not be interpreted as representing official policies, either expressed
27 * or implied, of JogAmp Community.
28 */
29
30package com.jogamp.nativewindow.util;
31
32import com.jogamp.common.type.WriteCloneable;
33
34/** Immutable Dimension Interface, consisting of it's read only components:<br>
35 * <ul>
36 * <li><code>width</code></li>
37 * <li><code>height</code></li>
38 * </ul>
39 */
40public interface DimensionImmutable extends WriteCloneable, Comparable<DimensionImmutable> {
41
42 int getHeight();
43
44 int getWidth();
45
46 /**
47 * <p>
48 * Compares square of size.
49 * </p>
50 * {@inheritDoc}
51 */
52 @Override
53 public int compareTo(final DimensionImmutable d);
54
55 /**
56 * Checks whether two dimensions objects are equal. Two instances
57 * of <code>DimensionReadOnly</code> are equal if two components
58 * <code>height</code> and <code>width</code> are equal.
59 * @return <code>true</code> if the two dimensions are equal;
60 * otherwise <code>false</code>.
61 */
62 @Override
63 boolean equals(Object obj);
64
65 @Override
66 int hashCode();
67
68}
Immutable Dimension Interface, consisting of it's read only components:
boolean equals(Object obj)
Checks whether two dimensions objects are equal.
int compareTo(final DimensionImmutable d)