com.github.katjahahn.parser.StandardField Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of portex_2.12 Show documentation
Java library to parse Portable Executable files
The newest version!
/*******************************************************************************
 * Copyright 2014 Katja Hahn
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package com.github.katjahahn.parser;

/**
 * A data class for a typical entry of PE Headers.
 * 
 * @author Karsten Hahn
 * 
 */
public class StandardField {

    /**
     * The key that describes the field.
     */
    private final HeaderKey key;
    /**
     * A description of the field, usually a better readable name for the key.
     */
    private final String description;
    /**
     * The actual value of the field entry.
     */
    private final Long value;

    /**
     * The file offset of the entry
     */
    private final long offset;

    /**
     * The size of the entry value
     */
    private final long size;

    /**
     * Creates a standard entry with the values specified.
     * 
     * @param key
     *            the key that describes the field
     * @param description
     *            of the field
     * @param value
     *            of the field entry
     * @param offset
     *            the file offset of the entry
     * @param size
     *            the size of the value
     */
    public StandardField(HeaderKey key, String description, Long value,
            long offset, long size) {
        this.key = key;
        this.description = description;
        this.value = value;
        this.size = size;
        this.offset = offset;
    }

    /**
     * Returns the key that describes this field
     * 
     * @return header key of this field
     */
    public HeaderKey getKey() {
        return key;
    }

    /**
     * Returns the actual value of the field entry.
     * 
     * @return value of the field entry
     */
    public long getValue() {
        return value;
    }

    /**
     * Returns a description of the field, usually a better readable name for
     * the key.
     * 
     * @return description of the field
     */
    public String getDescription() {
        return description;
    }

    /**
     * Returns the file offset of the entry
     * 
     * @return file offset of the entry
     */
    public long getOffset() {
        return offset;
    }

    /**
     * Returns the size of the entrie's value in bytes
     * 
     * @return size of entrie's value in bytes
     */
    public long getSize() {
        return size;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        if (value == null) {
            return description;
        }
        return description + ": " + value + " (0x" + Long.toHexString(value)
                + ")";
    }
}