メソッドの詳細

• getName

  StringSE getName()

  パッケージプレフィックスを含むエンティティ名。

  戻り値:

  null を返してはなりません。

• getPersistenceConstructor

  @Nullable
  PreferredConstructor<T,P> getPersistenceConstructor()

  この PersistentEntity のオブジェクトをインスタンス化するために使用される PreferredConstructor を返します。

  戻り値:

  自動構築に適したコンストラクターが見つからない場合は null。これは通常、その永続エンティティのオブジェクトのインスタンス化が、顧客の EntityInstantiator を介して行われるか、カスタム変換メカニズムによって完全に処理されることを示しています。

• isConstructorArgument

  boolean isConstructorArgument(PersistentProperty<?> property)

  指定された PersistentProperty が PersistentEntity のコンストラクター引数によって参照されるかどうかを返します。

  パラメーター:

  property - null でもかまいません。

  戻り値:

  指定された PersistentProperty がコンストラクター引数によって参照される場合は true、そうでない場合は null。

• isIdProperty

  boolean isIdProperty(PersistentProperty<?> property)

  指定された PersistentProperty がエンティティの id プロパティであるかどうかを返します。

  パラメーター:

  property - null でもかまいません。

  戻り値:

  プロパティが true の場合、エンティティ ID です。

• isVersionProperty

  boolean isVersionProperty(PersistentProperty<?> property)

  指定された PersistentProperty がエンティティのバージョンプロパティかどうかを返します。

  パラメーター:

  property - null でもかまいません。

  戻り値:

  true は、バージョンとして使用される特定のプロパティです。

• getIdProperty

  @Nullable
  P getIdProperty()

  PersistentEntity の id プロパティを返します。これがカスタム変換によって完全に処理されるエンティティである場合は、null にすることができます。

  戻り値:

  PersistentEntity の id プロパティ。

• getRequiredIdProperty

  default P getRequiredIdProperty()

  PersistentEntity の id プロパティを返します。

  戻り値:

  PersistentEntity の id プロパティ。

  例外:

  IllegalStateExceptionSE - PersistentEntity が id プロパティを定義していない場合。

  導入:

  2.0

• getVersionProperty

  @Nullable
  P getVersionProperty()

  PersistentEntity のバージョンプロパティを返します。エンティティで使用できるバージョンプロパティがない場合は null にできます。

  戻り値:

  PersistentEntity のバージョンプロパティ。

• getRequiredVersionProperty

  default P getRequiredVersionProperty()

  PersistentEntity のバージョンプロパティを返します。エンティティで使用できるバージョンプロパティがない場合は null にできます。

  戻り値:

  PersistentEntity のバージョンプロパティ。

  例外:

  IllegalStateExceptionSE - PersistentEntity がバージョンプロパティを定義していない場合。

  導入:

  2.0

• getPersistentProperty

  @Nullable
  P getPersistentProperty(StringSE name)

  名前で PersistentProperty インスタンスを取得します。

  パラメーター:

  name - プロパティの名前。null にすることができます。

  戻り値:

  PersistentProperty、または存在しない場合は null

• getRequiredPersistentProperty

  default P getRequiredPersistentProperty(StringSE name)

  指定された名前の PersistentProperty を返します。

  パラメーター:

  name - プロパティの名前。null または空にすることができます。

  戻り値:

  指定された名前の PersistentProperty

  例外:

  IllegalStateExceptionSE - 指定された名前のプロパティが存在しない場合。

• getPersistentProperty

  @Nullable
  default P getPersistentProperty(ClassSE<? extends AnnotationSE> annotationType)

  指定された型の AnnotationSE を備えた最初のプロパティを返します。

  パラメーター:

  annotationType - null であってはなりません。

  戻り値:

  指定されたアノテーション型のプロパティが見つからない場合は null。

  導入:

  1.8

• getPersistentProperties

  IterableSE<P> getPersistentProperties(ClassSE<? extends AnnotationSE> annotationType)

  指定された型の AnnotationSE を備えたすべてのプロパティを返します。

  パラメーター:

  annotationType - null であってはなりません。

  戻り値:

  一致が見つからない場合は、空の IteratorSE。null になることはありません。

  導入:

  2.0

• hasIdProperty

  boolean hasIdProperty()

  PersistentEntity に id プロパティがあるかどうかを返します。この呼び出しが true を返す場合、getIdProperty() は null 以外の値を返します。

  戻り値:

  エンティティに id プロパティがある場合は true。

• hasVersionProperty

  boolean hasVersionProperty()

  PersistentEntity にバージョンプロパティがあるかどうかを返します。この呼び出しが true を返す場合、getVersionProperty() は null 以外の値を返します。

  戻り値:

  エンティティにバージョンプロパティがある場合は true。

• getType

  ClassSE<T> getType()

  このエンティティの解決された Java 型を返します。

  戻り値:

  このエンティティの基本となる Java クラス。null になることはありません。

• getTypeAlias

  Alias getTypeAlias()

  型情報を格納するときに使用されるエイリアスを返します。マッピングメタデータを介して定義されたエイリアスがないことを示すために null になる場合があります。

  戻り値:

• getTypeInformation

  TypeInformation<T> getTypeInformation()

  この PersistentEntity をサポートする TypeInformation を返します。

  戻り値:

• doWithProperties

  void doWithProperties(PropertyHandler<P> handler)

  指定された PropertyHandler を、この PersistentEntity に含まれるすべての PersistentProperty に適用します。

  パラメーター:

  handler - null であってはなりません。

• doWithProperties

  void doWithProperties(SimplePropertyHandler handler)

• doWithAssociations

  void doWithAssociations(AssociationHandler<P> handler)

  指定された AssociationHandler を、この PersistentEntity に含まれるすべての Association に適用します。

  パラメーター:

  handler - null であってはなりません。

• doWithAssociations

  void doWithAssociations(SimpleAssociationHandler handler)

• doWithAll

  default void doWithAll(PropertyHandler<P> handler)

  指定された PropertyHandler を、すべての PersistentProperty と、すべての Association のすべての逆プロパティの両方に適用します。

  パラメーター:

  handler - null であってはなりません。

  導入:

  2.5

• findAnnotation

  @Nullable
  <A extends AnnotationSE> A findAnnotation(ClassSE<A> annotationType)

  PersistentEntity で指定された型のアノテーションを検索します。

  パラメーター:

  annotationType - null であってはなりません。

  戻り値:

  見つからない場合は null。

  導入:

  1.8

• getRequiredAnnotation

  default <A extends AnnotationSE> A getRequiredAnnotation(ClassSE<A> annotationType)
                                                  throws IllegalStateExceptionSE

  PersistentEntity の指定された型の必要なアノテーションを返します。

  パラメーター:

  annotationType - null であってはなりません。

  戻り値:

  アノテーション。

  例外:

  IllegalStateExceptionSE - 必要な annotationType が見つからない場合。

  導入:

  2.0

• isAnnotationPresent

  <A extends AnnotationSE> boolean isAnnotationPresent(ClassSE<A> annotationType)

  指定された型のアノテーションが PersistentEntity に存在するかどうかを確認します。

  パラメーター:

  annotationType - null であってはなりません。

  戻り値:

  指定された型の AnnotationSE が存在する場合は true。

  導入:

  2.0

• getPropertyAccessor

  <B> PersistentPropertyAccessor<B> getPropertyAccessor(B bean)

  指定された Bean のプロパティ値にアクセスする PersistentPropertyAccessor を返します。

  パラメーター:

  bean - null であってはなりません。

  戻り値:

  新しい PersistentPropertyAccessor。

  導入:

  1.10

• getPropertyPathAccessor

  <B> PersistentPropertyPathAccessor<B> getPropertyPathAccessor(B bean)

  指定された Bean のプロパティ値にアクセスする PersistentPropertyPathAccessor を返します。

  パラメーター:

  bean - null であってはなりません。

  戻り値:

  新しい PersistentPropertyPathAccessor

  導入:

  2.3

• getIdentifierAccessor

  IdentifierAccessor getIdentifierAccessor(ObjectSE bean)

  指定された Bean の IdentifierAccessor を返します。

  パラメーター:

  bean - null であってはなりません。

  戻り値:

  新しい IdentifierAccessor。

  導入:

  1.10

• isNew

  boolean isNew(ObjectSE bean)

  静的メタデータに従って、指定された Bean が新しいと見なされるかどうかを返します。

  パラメーター:

  bean - null であってはなりません。

  戻り値:

  指定された Bean が新しいインスタンスと見なされるかどうか。

  例外:

  IllegalArgumentExceptionSE - 指定された Bean が PersistentEntity で表される typ のインスタンスではない場合。

• isImmutable

  boolean isImmutable()

  エンティティが不変であると見なされるかどうかを返します。つまり、クライアントは getPropertyAccessor(Object) を介して取得された PersistentPropertyAccessor を介してインスタンスを変更しようとするべきではありません。

  戻り値:

  導入:

  2.1

  関連事項:

  Immutable

• requiresPropertyPopulation

  boolean requiresPropertyPopulation()

  エンティティにプロパティを設定する必要があるかどうか、つまり、コンストラクターによって初期化されていないプロパティが存在するかどうかを返します。

  戻り値:

  導入:

  2.1