Package org.beanio.internal.parser

Class Segment

    • Constructor Detail

      • Segment

        public Segment()

    • Method Detail

      • clearValue

        public void clearValue​(ParsingContext context)
        Description copied from interface: Parser
        Clears the current property value.
        Parameters:
        context - the ParsingContext

      • matches

        public boolean matches​(UnmarshallingContext context)
        Description copied from interface: Parser
        Returns whether this parser and its children match a record being unmarshalled.
        Parameters:
        context - the UnmarshallingContext
        Returns:
        true if matched, false otherwise

      • unmarshal

        public boolean unmarshal​(UnmarshallingContext context)
        Description copied from interface: Parser
        Unmarshals a record.
        Parameters:
        context - the UnmarshallingContext
        Returns:
        true if this component was present in the unmarshalled record, or false otherwise

      • marshal

        public boolean marshal​(MarshallingContext context)
                throws java.io.IOException
        Description copied from interface: Parser
        Marshals a record.
        Parameters:
        context - the MarshallingContext
        Returns:
        whether a value was marshalled
        Throws:
        java.io.IOException - if an I/O error occurs

      • hasContent

        public boolean hasContent​(ParsingContext context)
        Description copied from interface: Parser
        Returns whether this parser or any of its descendant have content for marshalling.
        Parameters:
        context - the ParsingContext
        Returns:
        true if there is content for marshalling, false otherwise

      • getValue

        public java.lang.Object getValue​(ParsingContext context)
        Description copied from interface: Parser
        Returns the unmarshalled property value.
        Parameters:
        context - the ParsingContext
        Returns:
        the property value

      • setValue

        public void setValue​(ParsingContext context,
                     java.lang.Object value)
        Description copied from interface: Parser
        Sets the property value for marshaling.
        Parameters:
        context - the ParsingContext
        value - the property value

      • getProperty

        public Property getProperty()

      • setProperty

        public void setProperty​(Property property)

      • isOptional

        public boolean isOptional()
        Description copied from interface: Parser
        Returns whether this node must exist during unmarshalling.
        Returns:
        true if this node is optional during unmarshalling, false otherwise

      • setOptional

        public void setOptional​(boolean optional)

      • setSize

        public void setSize​(int size)

      • getSize

        public int getSize()
        Description copied from interface: Parser
        Returns the size of a single occurrence of this element, which is used to offset field positions for repeating segments and fields.

        The concept of size is dependent on the stream format. The size of an element in a fixed length stream format is determined by the length of the element in characters, while other stream formats calculate size based on the number of fields. Some stream formats, such as XML, may ignore size settings.

        Returns:
        the size of this parser element

      • isIdentifier

        public boolean isIdentifier()
        Description copied from interface: Parser
        Returns whether this parser or any descendant of this parser is used to identify a record during unmarshalling.
        Returns:
        true if this parser or any descendant is used to identify a record

      • setIdentifier

        public void setIdentifier​(boolean identifier)

      • registerLocals

        public void registerLocals​(java.util.Set<ParserLocal<?>> locals)
        Description copied from class: Component
        Called by a stream to register variables stored in the parsing context. This method should be overridden by subclasses that need to register one or more parser context variables.
        Overrides:
        registerLocals in class Component
        Parameters:
        locals - set of local variables

      • isExistencePredetermined

        public boolean isExistencePredetermined()

      • setExistencePredetermined

        public void setExistencePredetermined​(boolean existencePredetermined)

      • isRepeating

        public boolean isRepeating()

      • setRepeating

        public void setRepeating​(boolean repeating)