java.lang

インタフェース Comparable<T>

型パラメータ:

T - このオブジェクトが比較されるオブジェクトの型

既知のすべてのサブインタフェース:

Delayed, Name, Path, RunnableScheduledFuture<V>, ScheduledFuture<V>

既知のすべての実装クラス:

AbstractRegionPainter.PaintContext.CacheMode, AccessMode, AclEntryFlag, AclEntryPermission, AclEntryType, AddressingFeature.Responses, Authenticator.RequestorType, BigDecimal, BigInteger, Boolean, Byte, ByteBuffer, Calendar, CertPathValidatorException.BasicReason, Character, Character.UnicodeScript, CharBuffer, Charset, ClientInfoStatus, CollationKey, Component.BaselineResizeBehavior, CompositeName, CompoundName, CRLReason, CryptoPrimitive, Date, Date, Desktop.Action, Diagnostic.Kind, Dialog.ModalExclusionType, Dialog.ModalityType, Double, DoubleBuffer, DropMode, ElementKind, ElementType, Enum, File, FileTime, FileVisitOption, FileVisitResult, Float, FloatBuffer, Formatter.BigDecimalLayoutForm, FormSubmitEvent.MethodType, GraphicsDevice.WindowTranslucency, GregorianCalendar, GroupLayout.Alignment, IntBuffer, Integer, JavaFileObject.Kind, JTable.PrintMode, KeyRep.Type, LayoutStyle.ComponentPlacement, LdapName, LinkOption, Locale.Category, Long, LongBuffer, MappedByteBuffer, MemoryType, MessageContext.Scope, Modifier, MultipleGradientPaint.ColorSpaceType, MultipleGradientPaint.CycleMethod, NestingKind, Normalizer.Form, NumericShaper.Range, ObjectName, ObjectStreamField, PKIXReason, PosixFilePermission, ProcessBuilder.Redirect.Type, Proxy.Type, PseudoColumnUsage, Rdn, Resource.AuthenticationType, RetentionPolicy, RoundingMode, RowFilter.ComparisonType, RowIdLifetime, RowSorterEvent.Type, Service.Mode, Short, ShortBuffer, SOAPBinding.ParameterStyle, SOAPBinding.Style, SOAPBinding.Use, SortOrder, SourceVersion, SSLEngineResult.HandshakeStatus, SSLEngineResult.Status, StandardCopyOption, StandardLocation, StandardOpenOption, StandardProtocolFamily, String, SwingWorker.StateValue, Thread.State, Time, Timestamp, TimeUnit, TrayIcon.MessageType, TypeKind, URI, UUID, WebParam.Mode, Window.Type, XmlAccessOrder, XmlAccessType, XmlNsForm

public interface Comparable<T>

このインタフェースを実装する各クラスのオブジェクトに全体順序付けを強制します。この順序付けはクラスの自然順序付けと呼ばれ、このクラスの compareTo メソッドは自然比較メソッドと呼ばれます。

このインタフェースを実装するオブジェクトのリスト (および配列) は、Collections.sort (および Arrays.sort) によって自動的にソートできます。このインタフェースを実装するオブジェクトはソートマップのキーとして使用したり、ソートセットの要素として使用したりできますが、その際に、コンパレータを指定する必要はありません。

クラス C の自然順序付けが equals と一貫性があると言われるのは、クラス C のすべての e1 と e2 について、e1.compareTo(e2) == 0 と e1.equals(e2) の boolean 値が同じになる場合だけです。null はいずれのクラスのインスタンスでもないため、e.equals(null) が false を返す場合でも e.compareTo(null) は NullPointerException をスローすべきです。

自然順序付けでは、equals と一貫性があることは、必須ではありませんが強く推奨されます。これは、明示的なコンパレータを指定しないソートセットやソートマップを、自然順序付けが equals と一貫性のない要素またはキーと一緒に使用すると、セットとマップの動作が保証されなくなるからです。特に、このようなソートセットまたはソートマップは、セットまたはマップの一般的な規約に違反します。この規約は、equals メソッドの用語を用いて定義されています。

たとえば、(!a.equals(b) && a.compareTo(b) == 0) となるような 2 つのキー a と b を、明示的なコンパレータを使用しないソートセットに追加する場合、2 つ目の追加操作では false が返され、ソートセットのサイズは増えません。これは、ソートセットから見ると a と b は等価であるためです。

Comparable を実装するほとんどの Java コアクラスは、equals と一貫性のある自然順序付けを持ちます。1 つの例外は java.math.BigDecimal です。このクラスの自然順序付けでは、異なる精度の同じ値 (4.0 と 4.00 など) を持つ BigDecimal オブジェクトは等価と見なされます。

数学的には、任意のクラス C に対して自然順序付けを定義する順序関係は次のようになります。

       {(x, y) such that x.compareTo(y) <= 0}.
 

この全体順序の商は次のとおりです。

       {(x, y) such that x.compareTo(y) == 0}.
 

compareTo の規約から判断して、商が C で同値関係にあり、自然順序付けが C の全体順序であるということは明らかです。クラスの自然順序付けが equals と一貫性があるということは、自然順序付けの商がクラスの次の equals(Object) メソッドで定義される同値関係になることを意味します。

     {(x, y) such that x.equals(y)}. 

このインタフェースは、Java Collections Framework のメンバーです。

導入されたバージョン:

1.2

関連項目:

Comparator

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
int	compareTo(T o) このオブジェクトと指定されたオブジェクトの順序を比較します。

メソッドの詳細

compareTo

int compareTo(T o)

このオブジェクトと指定されたオブジェクトの順序を比較します。このオブジェクトが指定されたオブジェクトより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数を返します。

実装では、すべての x と y に対して sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) が保証されなければいけません。これは、y.compareTo(x) が例外をスローする場合は x.compareTo(y) も例外をスローすることを意味します。

実装では、順序関係が推移的であることも保証されなければいけません。(x.compareTo(y)>0 && y.compareTo(z)>0) は x.compareTo(z)>0 を意味します。

さらに、すべての z に対して x.compareTo(y)==0 が sgn(x.compareTo(z)) == sgn(y.compareTo(z)) を意味することも保証されなければいけません。

必須というわけではありませんが、(x.compareTo(y)==0) == (x.equals(y)) であることが強く推奨されます。一般に、Comparable インタフェースを実装しているクラスで、この条件に違反するクラスはすべて、明確にこの事実を示す必要があります。「注:このクラスは equals と一貫性のない自然順序付けを持ちます」などと明示することをお勧めします。

前述の説明では、sgn(expression) という表記は数学関数 signum を示し、expression の値 (負の数、ゼロ、正の数) に応じて、-1、0、1 のどれかを返します。

パラメータ:

o -比較対象のオブジェクト。

戻り値:

このオブジェクトが指定されたオブジェクトより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数

例外:

NullPointerException - 指定されたオブジェクトが null の場合

ClassCastException - 指定されたオブジェクトの型が原因で、このオブジェクトと比較できない場合