|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.biojava3.protmod.Component
public final class Component
contains information about a certain Component.
The Component class uses the extensible enum pattern.
You can't instantiate Component directly, instead
you have to use one of the register
and of
methods.
Method Summary | |
---|---|
static Set<Component> |
allComponents()
|
Set<String> |
getPdbccIds()
|
boolean |
isCTerminal()
|
boolean |
isNTerminal()
|
static Component |
of(Set<String> pdbccIds)
Get a Component that does not have to occur at terminals. |
static Component |
of(Set<String> pdbccIds,
boolean isNTerminal,
boolean isCTerminal)
Get or create a Component. |
static Component |
of(String pdbccId)
Get a Component that does not have to occur at terminals. |
static Component |
of(String pdbccId,
boolean isNTerminal,
boolean isCTerminal)
Get or create a Component. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public Set<String> getPdbccIds()
public boolean isNTerminal()
public boolean isCTerminal()
public static Component of(String pdbccId)
pdbccIds
- possible Protein Data Bank ID.
IllegalArgumentException
- if pdbccId or type is null,
or the pdbccId has been registered as a different type.public static Component of(String pdbccId, boolean isNTerminal, boolean isCTerminal)
pdbccId
- Protein Data Bank ID.isNTerminal
- true if occurring at N-terminal. false, otherwise.isCTerminal
- true if occurring at C-terminal. false, otherwise.
IllegalArgumentException
- if pdbccId or type is null,
or the pdbccId has been registered as a different type,
or terminal condition is indicated for non-amino-acid component,
or both N-terminal and C-terminal are true.public static Component of(Set<String> pdbccIds)
pdbccIds
- a set of possible Protein Data Bank ID.
IllegalArgumentException
- if pdbccId or type is null,
or the pdbccId has been registered as a different type.public static Component of(Set<String> pdbccIds, boolean isNTerminal, boolean isCTerminal)
pdbccIds
- a set of possible Protein Data Bank ID.isNTerminal
- true if occurring at N-terminal. false, otherwise.isCTerminal
- true if occurring at C-terminal. false, otherwise.
IllegalArgumentException
- if pdbccId or type is null,
or the pdbccId has been registered as a different type,
or terminal condition is indicated for non-amino-acid component,
or both N-terminal and C-terminal are true.public static Set<Component> allComponents()
public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |